мета полягає в створенні системи онлайн-документації з такими основними вимогами:
- в основному буде використовуватися як проміжна стадія для кінцевих технічних документів усієї нашої програми (яка, ймовірно, ніколи не завершиться, хоча:]). Зазвичай це використовується так: у когось є проблема, я її виправляю і записую виправлення негайно. Те, що відбувається зараз, стає немислимим: у когось є проблема, я її вирішую, і я, і хтось щасливий, але через 2 місяці у когось іншого є така ж проблема, і ніхто не пам’ятає, що було виправлено.
- доступ звідусіль, працює за нашим сервером apache
- управління користувачами / групами, що дозволяє доступ лише для читання / читання-запису / адміністратора
- формат не надто важливий: звичайний текст зробив би, хоча в стилі вікі було б приємніше
- дешево або безкоштовно
кілька моїх ідей:
- просто обслуговуйте файли на спільному файлі або через ssh (мінуси: не надто сумісні з Windows, плюси: простий, може бути будь-який тип файлу)
- зберігайте його в SCM (svn / git, idem, як вище, але простіший доступ і контроль доступу)
- Злиття: ми вже використовуємо Джиру, чи вартує Конфлуенс? Як вона інтегрується з Джирою?
- щось ще?
Не соромтеся коментувати це або поділіться своїм досвідом з іншими системами.
Чи створюється документація з коду (наприклад, Javadocs) чи вона пишеться з нуля, як посібник користувача, чи якась їх комбінація?
—
FrustratedWithFormsDesigner
це головним чином посібник користувача, а не документація з кодом (ну, у нас це теж є, згенерований доксигеном, ми можемо включити його, але це не перша точка інтересу)
—
stijn
Я б передав трохи грошей Спольському.
—
Робота