Stackoverflow запустил раздел «Документация»

в 10:58, , рубрики: stackoverflow, документация, документирование кода, Программирование, сопровождение

Вчера произошло достаточно значимое событие на рынке разработки. Точнее в сфере поддержки и сопровождении программных продуктов. StackOverflow запустил раздел документация. Почему это важно?

На протяжении последних лет, когда github захватил рынок дистрибуции исходных кодов, проблема документации стояла остро. Не смотря на удобство работы с кодом, github так и не смог предложить достойной системы ведения документации – wiki забрасываются, а вести их через cvs попросту слишком трудоемко. ReadTheDocs попробовавший решить эту проблему, явно не совершил переворота, подойдя к проблеме в лоб. Так же есть gitbook, но и его трудно назвать стандартом.

На сегодня существуют следующие проблемы, с которыми сталкиваются разработчики:

  1. Отсутствие удобного способа вести многостраничную документацию со сложной навигацией.
  2. Необходимость взаимодействия множества авторов.
  3. Отсутствие единого стиля оформления документов. Возьмите туже документацию по Mongoose – раздражающие цвета, бедная подстветка синтаксиса.
  4. Необходимость выбора места хранения и дистрибуции.
  5. Проблемы "бумажной" работы сами по себе.

Судя по тому, что предлагает StackOverflow, мы получим интересный инструмент, позволяющий решить вышеперечисленные проблемы и позволяющий сделать ведение документации простым процессом. Из возможностей:

  1. Совместная разработка с поддержкой сравнений (diff).
  2. Запрос на создание статьи.
  3. Голосования за изменения, вместо единого автора.
  4. Стандартная система поощрения stackoverflow.

Остается надеяться, что в скором времени у нас появится больше качественной документации и муторный и для некоторых неприятный процесс ее ведения наконец-то станет приятным.

Автор: rumkin

Источник

Поделиться новостью

* - обязательные к заполнению поля