Краткое содержание. Ноябрь - Canonical (делают Ubuntu) опубли | Shut up and write
Краткое содержание. Ноябрь
- Canonical (делают Ubuntu) опубликовали свои планы по преобразованию документации. За основу документации берут фреймворк Diátaxis. Считают, что документация очень важна. Планируют создать и поддерживать техническую документацию и практику документирования, которые будут представлять собой стандарт в отрасли.
- Github опубликовали ежегодный отчет. Документация часто является недостаточно обеспеченной областью проектов, несмотря на то, что она имеет решающее значение для привлечения новых участников, повышения качества работы и создания общего понимания. Разработчики видят примерно 50% повышение производительности благодаря простой в использовании документации.
- Postman опубликовали 2021 State of the API Report. Документация один из топ 4-х факторов, которые учитываются при интеграции с API. Главным препятствии для использования API назвали отсутствие документации, так ответили 55 % респондентов. Наиболее полезным улучшением в документации API – это улучшенные примеры, примеры кода и стандартизация.
- Confluence добавили возможность вставить несколько Excerpt macros с одной и той же страницы.
- DITA контент теперь можно публиковать с помощью mkdocs.
- А в Ditto (инструмент для работы с текстами в интерфейсе) можно добавлять переменные в текст.
- Redocly рассказали про преимущества их VS Code extension.
Планы на декабрь
- Вторая часть вручения DevPortal Awards. Бесплатно, онлайн.
- Митап Tempo presents: Scaling your content team. Платно, онлайн.
- Митап Delightful Editorial Experiences. A Sanity.io Open House. Бесплатно, онлайн.
- Адвент календарь про лучшие практики Confluence от k15t.
#полезныессылки