TGViewer
Shut up and write Shut up and write @shut_up_and_write · 640 subscribers
Post #210 890
Краткое содержание. Ноябрь

- 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.

#полезныессылки
Ubuntu The future of documentation at Canonical | Ubuntu Our software documentation is part of the way we talk to our users and community - this is how we're going to change it, radically, for the better.
  • 👍 1
More from @shut_up_and_write
  1. Feb 4, 2022Как Twilio создают документацию Пересказ доклада Twilio про пределывание их документации.…
  2. Jan 21, 2022Docs for Developers Обзор на книгу Docs for Developers: An Engineer’s Field Guide to Techn…
  3. Jan 14, 2022Про редизайн документации GitLab - 2 GitLab проводит ежегодные опросы пользователей, чтобы…
  4. Jan 7, 20222021 → 2022 Краткое содержание 2021 и тренды на 2022. Что произошло за 2021 год - Gitlab,…
  5. Dec 24, 2021​​Какой длины делать обучающие видео? Компания TechSmith, которая делает Snagit и Camtasia…
  6. Dec 17, 2021The Best Developer Portals of 2021 Объявили победителей премии The Best Developer Portals.…
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →