← назад

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

1. Анализ задачи на документирование модуля или новой разработки.
2. Общее ознакомление с модулем или новой разработкой из доступных источников.
3. Технические настройки для нового документа в едином источнике: добавить переменные, создать новый build, тиражировать шаблоны, дописать конфигурации в файл сборки INI.
4. Участник проекта посвящает во все новые определения, рабочие процессы и функции.
5. Участник проекта демонстрирует прохождение по рабочим процессам модуля или работу функций, предназначенных для пользователя.
6. Разработка документа и тестирование системы самостоятельно. Анализ настроек в системе: рабочих процессов, коннекторов, типов объектов и т.д. Настройка бизнес-кейсов в системе. Периодически отправлять текущую версию документа на согласование команде разработки. Если не предоставлен доступ к целевой системе или модулю, то процесс документирования ставится на hold.
7. Редактура готового документа.
8. Согласование и тестирование готового документа:
   1. Автор проверяет документацию на полноту описания в соответствии с требованиями технического задания на систему.
   2. Разработчик(и) проверяет документацию на полноту описания разработанных функций. Разработчик смотрит только сам факт наличия описания по каждой функции и больше ничего. Таким образом, на задачу ему потребуется 5-10 минут в зависимости от количества разработанных и описанных функций.
   3. Тестировщик(и) проверяет документацию на актуальность. Тестирует документацию на применимость и удобство использования.
   4. Корректор или редактор (при наличии таких в штате компании) проверяет документацию на наличие грамматических и пунктуационных ошибок. Проверяет стиль изложения, соответствующий техническим документам. Проверяет типографику и соответствие ГОСТам.
   5. Любой сотрудник (лучше всего из отдела продаж), имеющий отношение к работе с системой, проверяет документацию на предмет удобства чтения: понятно ли написано, хорошо ли организован текст (структура документа), легко ли читается текст. При проверке учитывает последние пожелания или замечания заказчика к документации.
9. Подключение веб-версии документа к системе или модулю.