Поделиться информацией можна и вовсе не жалко, тем более ничего здесь секретного нет, а кому-то может помочь
Не знаю как везде, но работаем приблизительно так.
Есть шаблон ворд-документа, с колонтитулами, логотипами, который используется для ведения документации (печатаются потом для клиентов).
Проджект-менеджер или ведущий программист проекта получает ТЗ от начальства на какую-то фичу проекта. После чего сам, или посовещавшись с остальными разрабатывает концепцию. Сначала все это утверждается с начальством, т.е. до окончательного варианта получается несколько версий документа (_v1, _v2, vXXX). Затем ставит эту задачу нескольким людям и прикрепляет этот документ. Если в процессе реализации программист видит более оптимальные пути реализации, то он изменяет документ и с новой версии кладет в папку документации проекта, уведомив того, кто ему эту задачу установил.
Собственно структура документа:
Вначале информация типа
Заголовок: Статистика пользователей
Проект: Пример
Документ-ID: - если используется какая-то система управления документами.
Автор: Вася Пупкин
Версия: V6
Дата: 28-12-2006
Статус: Подготовка (или к исправлению, утвержден)
Может быть таблица изменений
Кто | Когда | Цель изменений
Далее основные разделы:
1. Описание того, что нужно реализовать (2-3 абзаца), ссылки на существующие аналоги, может быть дополнительная документация, с которой следовало бы ознакомиться перед началом работы.
2. Как это все будет выглядеть, если присутствуют элементы GUI (ссылки на скриншоты или прикрепленные документы)
3. Реализация:
a. базовая информация о том, на какие моменты следует обратить внимание.
b. если реализовуется GUI, то описание всех страниц, их назначение.
c. Список новых классов с указанием интерфейса для каждого
d. Какие изменения и связи в БД
4. Интеграция в систему: возможно создание каких-то прав доступа или другие особенности.
5. Расчет производственных ресурсов: сколько человек, сколько человек/часов на каждый из вышеперечисленных пунктов + время на тестирование и фиксы найденных багов. Расчеты конечно делаются приблизительные.
6. Дополнительные примечания.
Система не идеальная, но рабочая. Стандартов в этой области думаю нет и каждая компания сама строит этот процесс, у кого-то недостаточно людей для создания и ведения подобного рода документации, кому-то она просто-напросто не нужна, а также все зависит от заказчика, который может поставить обязательным условием ведение проектной документации на всех шагах реализации проекта.
Вы можете всегда сделать так, как вам удобней
