Вчера произошло достаточно значимое событие на рынке разработки. Точнее в сфере поддержки и сопровождении программных продуктов. StackOverflow запустил раздел документация. Почему это важно?
На протяжении последних лет, когда github захватил рынок дистрибуции исходных кодов, проблема документации стояла остро. Не смотря на удобство работы с кодом, github так и не смог предложить достойной системы ведения документации – wiki забрасываются, а вести их через cvs попросту слишком трудоемко. ReadTheDocs попробовавший решить эту проблему, явно не совершил переворота, подойдя к проблеме в лоб. Так же есть gitbook, но и его трудно назвать стандартом.
На сегодня существуют следующие проблемы, с которыми сталкиваются разработчики:
- Отсутствие удобного способа вести многостраничную документацию со сложной навигацией.
- Необходимость взаимодействия множества авторов.
- Отсутствие единого стиля оформления документов. Возьмите туже документацию по Mongoose – раздражающие цвета, бедная подстветка синтаксиса.
- Необходимость выбора места хранения и дистрибуции.
- Проблемы "бумажной" работы сами по себе.
Судя по тому, что предлагает StackOverflow, мы получим интересный инструмент, позволяющий решить вышеперечисленные проблемы и позволяющий сделать ведение документации простым процессом. Из возможностей:
- Совместная разработка с поддержкой сравнений (diff).
- Запрос на создание статьи.
- Голосования за изменения, вместо единого автора.
- Стандартная система поощрения stackoverflow.
Остается надеяться, что в скором времени у нас появится больше качественной документации и муторный и для некоторых неприятный процесс ее ведения наконец-то станет приятным.
Автор: rumkin
