Програмне забезпечення для організації та підтримки проектної документації, специфікації? [зачинено]

Я шукаю програмне забезпечення для організації та підтримки внутрішньої документації проектів, специфікацій, вимог тощо. В даний час ми зберігаємо всю документацію як багато файлів MS Word DOC у сховищі управління джерелами, що дає нам контроль над версіями, і це приємно. Але ви не можете шукати цю інформацію, створювати зв’язки між ними, класифікувати, співпрацювати.

Вимоги, налаштування:

• Нульова установка на стороні клієнта (на базі WEB).
• Контроль версій документа.
• Анотації до документа
• Посилання документа.
• Повний пошук (вся документація).
• MS Word (* .doc) імпорт \ експорт.
• Текстовий редактор WYSIWYG.

Системи, які я відкрив і випробував до цих пір:

• MediaWiki
• XWiki
• Злиття

Як щодо чогось на зразок сфінкса ?

Ви записуєте свою документацію в reStructuredText (синтаксис схожий на Markdown, який використовує переповнення стека) у текстові файли у звичайному тексті (= простий у керуванні версіями), а Sphinx розплющує HTML-сторінки.

Два найвидатніших користувачів Sphinx (про яких я знаю) - мова Python та TortoiseHG (див. Посилання на створену документацію про Sphinx).

Редагувати:

Я просто прочитав, що ви говорите про внутрішню проектну документацію, а не про документацію для кінцевого користувача.
На мою думку, щось на зразок Sphinx - це найкращий спосіб і для внутрішньої документації (за умови, що ви можете змусити своїх аналітиків писати reStructuredText), оскільки:

1. Ви можете легко керувати версіями документів (а текстові файли відрізняються значно більше, ніж менше, ніж двійкові файли, такі як .doc або .pdf).
2. Якщо розробник хоче добре читати .doc або .pdf файл, він може створити його за допомогою Sphinx з джерел.

Якщо Сфінкс занадто складний, є навіть більш простий спосіб: ви можете написати свою документацію в Markdown і використовувати Pandoc для створення (наприклад) .rtf, .doc або .pdf файлів (це може зробити набагато більше).
Мені Pandoc легше почати роботу, ніж Сфінкс, але Pandoc не може створити приємні ієрархії меню, як Sphinx (як, наприклад, у документації Python та TortoiseHG, яку я пов’язував вище).

Незалежно від того, який з інструментів ви використовуєте, якщо у вас є внутрішній веб-сервер і сервер збірки, ви можете налаштувати його так, щоб сервер збірки генерував вихід HTML і копіював це на веб-сервері кожного разу, коли хтось щось підштовхує до документації. Тож вашим аналітикам навіть не доводиться думати про остаточний результат, вони просто зобов'язані здійснити та просувати свої зміни.

Ну, ви можете спробувати реалізувати Wiki. Mediawiki має всі відсутні функції, про які ви говорите (функції пошуку, історія версій, посилання, категоризація). Вам потрібно буде переконатися, що ви точно знаєте, яка версія документації належить до якої версії програмного забезпечення, але це може бути зроблено шляхом дозволу на включення до кожної статті, залежної від версії, посилання на версію.

АЛЕ: Ви пишете, що у вас є "аналітики", які не є розробниками (я визнаю, я не шанувальник цього сузір'я). Такі люди часто не раді, коли ви замінюєте їх інструменти MS Office якимись текстовими інструментами, такими як Wiki. А оскільки MS-Word не є безкоштовним програмним забезпеченням, тож, мабуть, вимога "вільне програмне забезпечення" насправді не є обов'язковою. У цій ситуації кращою альтернативою може бути сервер Sharepoint. Не безкоштовно, але AFAIK має всі функції, про які ви запитуєте, а документи все ще можна створювати за допомогою Word, Excel тощо.

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

1. Trac - Проста у використанні система відстеження помилок та система знань. Написаний на Python та розширюваний, ви працюєте за кілька хвилин
2. MoinMoin - повноцінний вікі-движок. Знову Python з великою кількістю функцій

Обидва мають мінімальний інтерфейс, підтримує більшість структур вікі, досить простий у розгортанні та обслуговуванні, підтримує зміни, має хороший редактор WYSIWYG, і ви навіть можете зберігати свою документацію та технічні характеристики. Якщо ваші проекти справді не величезні, ви можете вибрати будь-яке з перерахованого вище.

Нещодавно ми почали використовувати Alfresco DMS, який має багато цікавих властивостей:

• Дуже проста установка
• Має вбудований індексатор для швидкого пошуку по купі документів
• Дозволяє робочим потокам, групам і, якщо необхідно, конкретним доступом до документів клієнтами
• Відкрите джерело
• Активна спільнота
• Інтеграція LDAP / AD / SSO
• Обробляє багато різних документів

Є й деякі недоліки:

• Інтерфейс користувача не завжди інтуїтивно зрозумілий
• Це насправді не вікі, тому одночасна спільна робота над одним документом може бути дещо крихкою

Якщо ви вирішили розмахувати, будь ласка, зв'яжіться зі мною зі своїми думками.

Інша можливість може бути використовувати LaTeX або який - або інший текст formater (можливо Texinfo або навіть хам ) для документації. Частини його можна генерувати машиною. Існують деякі інструменти для перетворення HTML, наприклад, HeVeA для перетворення LaTeX в HTML. Ви також можете використовувати doxygen для генерування документації із структурованих коментарів всередині вихідного коду. І рукописними частинами документації можна (і слід) керувати як вихідний код (наприклад, керування версіями версії та складання).

Я б запропонував використати інструмент UML та ERD, крім ваших документів. Крім того, ви можете зберігати ці документи на ZOHO в ZOHO-Docs , що не безкоштовно, але це надзвичайно дешево і дозволяє засоби пошуку документів.

Який би інструмент ви не використовували, вам потрібно ретельно впорядкувати вміст документа, щоб мати змогу використовувати пошук тексту та отримувати значущі результати. Організація вмісту документів разом із розумним та стандартним іменем файлів може значно допомогти.