Как правильно версионировать документацию?

Как правильно версионировать документацию? Как бы всякие там wiki и confluence это конечно здорово, но хочется чтобы документация версионировалась параллельно с кодом и при этом выглядела чуть лучше чем README.md. Кто-то пользуется Hugo или Jekyll для этого? Как поддерживаете документацию в актуальном состоянии?

841   7  
Рабочие моменты

Comments

  1. Павел Сидорович
    Reply
    Павел Сидорович 6 лет назад
    readme1.md<br>readme2.md<br>...<br>readmeN.md
  2. Станислав Осипов
    Reply
    Станислав Осипов 6 лет назад
    Если мы про документы MSO, для него есть SharePoint. Но, уверен, что с кодом это никак не синхронизировать
  3. Илья Аблеев
    Reply
    Илья Аблеев 6 лет назад
    <img class="post-img" src="/upload/images/74575870_3738932336133078_7461244923509997568_n.jpg">
  4. Павел Покровский
    Reply
    Павел Покровский 6 лет назад
    Такой довольно расплывчатый вопрос. Интересует методология или инструментарий? Методология - есть семвер, инструментарий - https://readthedocs.org/
  5. Игорь Беспальчук
    Reply
    Игорь Беспальчук 6 лет назад
    Далеко не всю доеументацию имеет смысл версионировать параллельно коду. Проектные документы появляются раньше, описания типовых проблем и решений - позже, и т.д.
  6. Олексій Вайсруб
    Reply
    Олексій Вайсруб 6 лет назад
    Вспоминается документация к какому-то старенькому Linux.<br>"Our code is very well documented. Unfortunately in C language"<br><br>С момента, когда IDE стали достаточно умными, всякие doxygen/PHPDoc/PyDoc стали не нужными. А "User Manual" всё-равно вручную...
  7. Alexey Rybak
    Reply
    Alexey Rybak 6 лет назад
    Не хочется теоретизировать - что именно ты хочешь документировать? Или ты спрашиваешь именно «вообще»? Компоненты разные и необходимость документации тоже. UPDATE: И методы/процессы поддержания документации в актуальном состоянии - тоже!
Click here to cancel reply.