Какие инструменты для ведения документации используете Вы?

Question

[p4s8x]

Вопрос в заголовке.

В данный момент вся документация по всем проектам компании собрана в wiki, т.е. все технические задания, документация для разработчиков, юзердоки, отчеты находятся там. Это намного лучше, чем куча doc файликов на почте, но минус вики — сама вики. Не очень удобно с ней работать. Расскажите — как решается вопрос ведения документации в вашей компании? Какие технические средства, методики применяются?

Answer 1

[Александр Крылов]

Sharepoint Services — бесплатно и достаточно функционально. Есть wiki, библиотеки документов и несколько бесплатных шаблонов к ней от Microsoft.

Comments

[p4s8x]

Не хочется быть привязанным к конкретной платформе. Многие сотрудники работают из под Ubuntu. Есть техническая возможность организовать доступ к управлению документацией из под linux? Потеря «части» функционала возможно не критична.

[Александр Крылов]

Честно не пробывал, но сам Microsoft пишет, что поддерживаются следующие браузеры:
* Firefox 3.6, 32-разрядная версия для операционных систем, отличных от Windows
* Safari 4.04, для операционных систем, отличных от Windows

Answer 2

[soroktu]

Вики разные бывают, вот вы какую используете? И что понимаете под неудобством? Confluence на ощупь — весьма хороша, одна вставка скриншотов многого стоит.

А в последней фирме, которой я работал, документация велась в word, и попытки внедрить wiki ни к чему не привели, т.к. ни у кого не было ни времени ни желания изучать что-то новое. Увы…

Comments

[p4s8x]

Это — www.atlassian.com/software/confluence/overview? Очень интересно, изучим.

[soroktu]

Да, это оно. Цена для 10 пользователей божеская, всё что выше — стоит очень прилично…

Answer 3

[northbear]

Redmine. Там есть и трекер, внутреннее вики, и отдельный раздел для документов проекта… Документы проекта не суть важно в чем писать. Это больше зависит от того, что вы планируете потом сделать с этой документацией.

Помимо этого, обязательное документирование коммитов git-репозитарий.

Ну и собственно комментарии в коде никто не отменял. В Ruby/RoR есть довольно мощные утилиты, которые позволяют из комментариев в коде собирать довольно приличную документацию… Естественно для этого надо, чтобы комментарии писались по определенному шаблону-стандарту, иначе фигня получается…

Comments

[p4s8x]

Используем редмайн, но всетаки как треккер. Начинали как раз использовать tuj внутренний вики, но он совсем слабенький.
Пишем в основном на Yii + Ext JS и там и там есть генераторы документации аля php-doc.

Так и получается: задачи в редмайне, ТЗ в wiki, часть документации в коде, юзергайды часть в вики, часть в коде. Следить за изменениями в ТЗ очень сложно, увидеть — выполнена задача или нет — нужно лезть в трекер, потом отметить это в вики.

Наверное отслеживание изменений ТЗ — одна из основных проблем. У нас проекты делаются «для себя» и поэтому допускается изменение ТЗ в процессе.

[northbear]

У нас если вдруг намечается изменения ТЗ, то это повод для всеобщего сбора. Это приравнивается к смене заказчика. На сборе объясняют суть изменений и причины. Поэтому с отслеживанием изменений ТЗ у нас не проблема…

Answer 4

[Николай Турнавиотов]

Попробуйте любую систему документооборота — есть как платные, как бесплатные.
IIS + Sharepoint foundation входят штатно в роли windows 2008r2 и, при наличии C# разработчика — вполне интересный инструмент — я видел шикарные порталы на asp.net, iis…

Answer 5

[Эдуард Тибет]

svn (хранение) + docbook (формат) + Apache Cocoon (вывод представления)