Xpoint
   [напомнить пароль]

Система управления документацией

Метки: [без меток]
2007-01-19 16:39:02 [обр] firestorm[досье]

Коллеги, подскажите!

Мы ведем некоторый программный проект, настало время разрабатывать документацию.
Начали разрабатывать и стало понятно, что мы закопаемся в перекрестных ссылках, и в результате документация никогда не будет up2date.

Существуют ли какие-нибудь приличные системы ведения документации?

Что нам от нее нужно:

  1. Возможность ведения документации в сразу нескольких направлениях (Управление проектом - Тесты - Требования - Пользовательская документация и прочее)
  2. Возможность подгрузки актуальных кусков из выделенных мест (Из тестов в требования например)
  3. Система должна быть web (строго) - разработка ведется на C,php,perl под Linux, MacOS, Windows

Дополнительные возможности приветствуются.

?

Заранее спасибо за ответ!

спустя 1 день 7 часов [обр] Василий Свиридов(0/175)[досье]
А что-то типа MediaWiki? Сейчас много проектов пользуется Wiki для документации...
спустя 1 день 8 часов [обр] Ярослав Сюзёв (yara)(0/305)[досье]
PHPDocumentor (php only).
спустя 3 часа 52 минуты [обр] Василий Свиридов(0/175)[досье]
Ярослав Сюзёв (yara)[досье] Ну, это всё-таки пакет из серии JavaDoc, генерит API документацию из исходников. Я думаю автору темы нужны более "полные" продукты, типа Knowledge Tree
спустя 38 минут [обр] firestorm[досье]

Php Documentor нам не подходит, у нас используется не только PHP
В Knowledge Tree насколько я понял нет возможности работать с перекрестными ссылками, так что видимо будем использовать MediaWiki...

Хотя то, что хочется - не ссылки в тексте, а прямо сам текст. (понятно, что на исходной странице этот текст должен быть помечен).

Тема не закрыта, если у кого-то есть какие-то еще соображения - буду рад :)

спустя 2 месяца 17 дней [обр] Эльдар[досье]

Удобно использовать систему Confluence, организуются сообщества, публикуются документы, в рамках сообщества есть возможность редактирования документа, есть возможность встакви кода через теги, если используешь wiki. Уже советовали Wiki для документации, я думаю это подходящий вариант.
Вот ссылка http://www.atlassian.com/software/confluence/

Также там есть продукт под названием Jira, он упорядочивает работу в рамках отдела разработки ПО.

Powered by POEM™ Engine Copyright © 2002-2005