Ведення документації по проекту

Привіт Всім.

Поділіться досвідом в якому вигляді в вашій компанії чи на вашому проекті ведеться документація (якщо звісно ведеться): у вигляді одного документу, у вигляді окремого документу на кожну бізнес область/вікно/кнопку,...?

І чи існують якісь спеціалізовані тулзи щоб спростити роботу з документацією, структурувати її, дозволити легко знайти те що потрібно, переглянути останні зміни, організувати нотифікацію про останні зміни,...?

👍ПодобаєтьсяСподобалось0
До обраногоВ обраному0
LinkedIn
Дозволені теги: blockquote, a, pre, code, ul, ol, li, b, i, del.
Ctrl + Enter
Дозволені теги: blockquote, a, pre, code, ul, ol, li, b, i, del.
Ctrl + Enter

Для документирования кода — конечно же doxygen.

У нас один документ на проект — ТЗ. Проекты как правило небольшие. Иногда бывают два документа — один тз для заказчика и второе более техническое тз, которое могут использовать программисты. На практике спецификации представляют из себя выдержки из такого технического тз с доп. комментариями.
Насчет ведения своей документации лично я на сегодняшний день больше всего склоняюсь к вики. Еще удобная штука при управлении проектами — Microsoft Project.

Диаграммы удобно делать в Visio. Для uml самое простое решение это Dia.

Используем Wiki и MS SharePoint — последний как раз ответ на ваш вопрос.

Очень удобно (для внутренней! документации, которую активно создают/обновляют разработчики) использовать локальный wiki (например, MediaWiki). Поиск я не использовал, но, думаю, что должен быть. Нотификация о почте там есть в виде «подписки» на изменения на каждой конкретной странице.

Підписатись на коментарі