Инженерам-программистам нужны инструменты базы знаний для создания и ведения ценной технической документации. В отчете State of Octoverse 2021 компании GitHub говорится следующее:
«Документация* полезна для производительности и культуры. Последние исследования показывают, что качественная документация повышает производительность. Не стоит удивляться, что хорошая практика документирования не только поддерживает лучшие культуры, в которых разработчики чувствуют себя полноценными, но и помогает им выполнять свою работу «*.
В отчете DevOps Research and Assessment (DORA) 2021 также упоминается, что:
[…] документация является основой для **успешного внедрения возможностей DevOps*. Команды с высококачественной документацией в 3,8 раза чаще внедряют передовые методы обеспечения безопасности и в 2,5 раза чаще используют облако в полной мере*.
Это означает, что разработчики должны иметь доступ к эффективным инструментам обмена знаниями, предназначенным для разработки программного обеспечения.
Техническая документация для разработчиков программного обеспечения может иметь несколько форм:
- Вечная документация, например, процедуры по созданию проекта.
- Архитектурные принципы, которым разработчики должны следовать в своих проектах.
- Документация по выпуску
- Стандарты и рекомендации по кодированию
- руководства по введению в должность
и многое другое.
Обратите внимание, что в этом посте мы не рассматриваем инструменты, предоставляющие документацию конечным пользователям, такие как порталы самообслуживания (Zendesk, Intercom, …). Мы говорим о документации, созданной разработчиками для разработчиков. Мы также исключили инструменты для документирования API, которые относятся к специфической области, заслуживающей отдельной статьи.
Мы собрали 30 инструментов, полезных для управления технической документацией. Мы сгруппировали их в 5 категорий:
- Вики: эти инструменты предоставляют платформу и пользовательский интерфейс для управления контентом.
- Дискуссии: Q&A и форумы, обмен стандартами кодирования
- Генераторы: создание документации из файлов исходного кода
Вот общая картина 30 инструментов баз знаний для разработчиков:
А вот полный список со ссылками на каждый инструмент с их тегами.
Вики:
- Archbee — Создавайте лучшую документацию по продуктам — быстрее.
- Wiki.js (OpenSource) — Самое мощное и расширяемое программное обеспечение Wiki с открытым исходным кодом.
- ClickUp — Экономьте время с помощью универсальной платформы продуктивности, которая объединяет команды, задачи и инструменты в одном месте.
- Notion — Единое рабочее пространство для задач, заметок, вики и календаря.
- Swimm — Платформа документации, созданная для инженеров.
- Confluence — Confluence — это удобное рабочее пространство для удаленной команды, где знания и совместная работа объединяются.
- Coda — универсальный документ для команд.
- Bit.ai — Платформа нового поколения для совместной работы над документами для команд!
- Nuclino — Современный, простой и невероятно быстрый способ совместной работы — объедините знания, документы и проекты в одном месте.
- Papyrs — Самый простой способ создать онлайн-интранет для вашей компании.
- BookStack (Open Source) — BookStack — это простая, самостоятельная, удобная в использовании платформа для организации и хранения информации.
- Slab — Создайте культуру обмена знаниями уже сегодня.
- GitBook — Где команды разработчиков программного обеспечения преодолевают силос знаний.
- Developerhub.io — Универсальная платформа для онлайн-документации.
- Tettra — Лучший способ организации и обмена знаниями с членами вашей команды.
- DocsApp — Создание и публикация красивых, мощных и облачных хабов для разработчиков.
Обсуждения:
- Stack Overflow For Teams — Обмен знаниями и совместная работа без отвлекающих факторов.
- AnswerHub — Расширение возможностей разработчиков и команд для обучения, обмена и достижения успеха с помощью онлайн-сообществ и обмена знаниями.
- Flarum (с открытым исходным кодом) — Простые форумы. Современный, быстрый и бесплатный!
- Forem (Open Source) — Forem — это платформа с открытым исходным кодом для создания современных, независимых и безопасных сообществ.
- CodeStream — New Relic CodeStream — это бесплатное расширение с открытым исходным кодом для VS Code, Visual Studio и JetBrains.
- Promyze — Подключение знаний разработчиков и обмен лучшими практиками кодирования, полностью интегрированный в инструменты для разработчиков.
- Slab — Объедините знания разработчиков и поделитесь лучшими практиками кодирования, полностью интегрированными в инструменты разработчика.
Генераторы:
- Docusaurus (OpenSource) — быстро создавайте оптимизированные веб-сайты, сосредоточьтесь на своем контенте.
- Hugo (OpenSource) — Самый быстрый в мире фреймворк для создания веб-сайтов
- Daux.io (OpenSource) — Самый простой способ документирования вашего проекта
- SkyDocs (OpenSource) — SkyDocs — это легкий конструктор статической документации с MarkDown.
- Sphinx (OpenSource) — Sphinx позволяет легко создавать интеллектуальную и красивую документацию.
- Read The Docs (Open Source) — Read the Docs упрощает документирование программного обеспечения, автоматизируя создание, версионирование и хостинг документации за вас.
- MkDocs (Open Source) — Проектная документация с использованием Markdown.
- GitHub Pages — Веб-сайты для вас и ваших проектов.