Вчора відбулася досить значуща подія на ринку розробки. Точніше у сфері підтримки та супроводі програмних продуктів. StackOverflow запустив розділ документація. Чому це важливо?
Протягом останніх років, коли github захопив ринок дистрибуції вихідних кодів, проблема документації стояла гостро. Не дивлячись на зручність роботи з кодом, github так і не зміг запропонувати гідної системи ведення документації - wiki закидаються, а вести їх через cvs просто занадто трудомістко. ReadCeDocs спробував вирішити цю проблему, явно не здійснив перевороту, підійшовши до проблеми в лоб. Так само є gitbook, але і його важко назвати стандартом.
На сьогодні існують наступні проблеми, з якими стикаються розробники:
- Відсутність зручного способу вести багатосторінкову документацію зі складною навігацією.
- Потреба взаємодії багатьох авторів.
- Відсутність єдиного стилю оформлення документів. Візьміть тугіше документацію по Mongoose - подразнюючі кольори, бідна підствітка синтаксису.
- Потреба вибору місця зберігання та дистрибуції.
- Проблеми «» паперової «» роботи самі по собі.
Судячи з того, що пропонує StackOverflow, ми отримаємо цікавий інструмент, що дозволяє вирішити перераховані вище проблеми і дозволяє зробити ведення документації простим процесом. З можливостей:
- Спільна розробка з підтримкою порівнянь (diff).
- Запит на створення статті.
- Голосування за зміни, замість єдиного автора.
- Стандартна система заохочення stackoverflow.
Залишається сподіватися, що незабаром у нас з'явиться більше якісної документації і муторний і для деяких неприємний процес її ведення нарешті стане приємним.
