яку систему онлайн-технічної документації ви б рекомендували? [зачинено]


11

мета полягає в створенні системи онлайн-документації з такими основними вимогами:

  • в основному буде використовуватися як проміжна стадія для кінцевих технічних документів усієї нашої програми (яка, ймовірно, ніколи не завершиться, хоча:]). Зазвичай це використовується так: у когось є проблема, я її виправляю і записую виправлення негайно. Те, що відбувається зараз, стає немислимим: у когось є проблема, я її вирішую, і я, і хтось щасливий, але через 2 місяці у когось іншого є така ж проблема, і ніхто не пам’ятає, що було виправлено.
  • доступ звідусіль, працює за нашим сервером apache
  • управління користувачами / групами, що дозволяє доступ лише для читання / читання-запису / адміністратора
  • формат не надто важливий: звичайний текст зробив би, хоча в стилі вікі було б приємніше
  • дешево або безкоштовно

кілька моїх ідей:

  • просто обслуговуйте файли на спільному файлі або через ssh (мінуси: не надто сумісні з Windows, плюси: простий, може бути будь-який тип файлу)
  • зберігайте його в SCM (svn / git, idem, як вище, але простіший доступ і контроль доступу)
  • Злиття: ми вже використовуємо Джиру, чи вартує Конфлуенс? Як вона інтегрується з Джирою?
  • щось ще?

Не соромтеся коментувати це або поділіться своїм досвідом з іншими системами.


Чи створюється документація з коду (наприклад, Javadocs) чи вона пишеться з нуля, як посібник користувача, чи якась їх комбінація?
FrustratedWithFormsDesigner

це головним чином посібник користувача, а не документація з кодом (ну, у нас це теж є, згенерований доксигеном, ми можемо включити його, але це не перша точка інтересу)
stijn

Я б передав трохи грошей Спольському.
Робота

Відповіді:


11

Я збирався запропонувати Wiki

Оскільки Confluence - це вікі, я думаю, що використовувати її разом із вашим JIRA - це відмінна ідея. Ви матимете перевагу в тому, що зможете безпосередньо пов'язатись із проблемами JIRA, а отже, фактичним кодом / документом / будь-якими змінами, внесеними тощо.

Ключ до будь-якого коду doc repo, як це - навігаційний аспект. Ви не хочете, щоб сторінки, які від’єднуються, важко знайти тощо. Думайте про "макет сайту" так, як ви хотіли б для веб-сайту.


Злиття, очевидно, може експортуватися в різних плоских форматах. Звучить як один із найпростіших способів дістатися від легко редагованого до готового produc.t

2
У нас є Confluence, де я працюю - ми перейшли з MediaWiki - і це добре спрацьовує з різними форматами (Word є найпопулярнішим). Але будьте застережені, його інструменти для редагування WYSIWYG неймовірно баггі, а система тегів залишає бажати кращого, принаймні у нас.
Філіп Реган

+1 для Wiki, я також вважав Trac дуже корисним у тому випадку, оскільки він інтегрується з SVN, що дозволяє також ділитися файлами.

ми перевірили випробування Confluence, і це буде рішення. Здається, можна зробити набагато більше, ніж нам потрібно, але працювати з цим досить просто. Я спробував Trac пару років тому, і він був занадто безладним на мій смак, особливо коли мова зайшла про плагіни і т. Д.
stijn
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.