Документация для проекта
Вопрос
Какую документацию может/должен подготовить именно PM, чтобы после релиза команде разработки было удобнее поддерживать продукт?
Ответ
У документации есть существенные недостатки:
- Документацию никто не читает
- Документация не актуальна (решение изменилось, а документацию забыли поправить) - типичная проблема
- Документации всегда недостаточно или она настолько излишня, что сложно удержать в голове
Поэтому, в среде разработчиков считается, что вся документация должна быть сосредоточена в коде. Но этого недостаточно для людей, которые не умеют читать код :)
В целом же, достаточно иметь актуальную документацию по проекту, актуализировать ее по итогу проекта (в зависимости от того, насколько сложное решение у вас):
- Актуализированные требования (Техническое задание) по проекту
- Руководство пользователя
- Руководство администратора
- Архитектура решения
- Схема развертывания и зависимости решения
- Макеты, Карта сайта и т.д.
- Полезно иметь доступ к таск-треккеру, поскольку в задачах тоже содержится полезная информация (поиском по ней найти)
- Для разработчиков важно иметь доступ к репозиторию, иметь возможность смотреть коммиты и делать поиск по ним (это тоже документация)
- Переписка, почта - здесь содержится информация о том, какие решения были приняты и почему они были приняты
- В документах полезно иметь лист изменений, где описана версия документа, что изменилось и почему изменилось.
И в целом - всю эту документацию готовит не столько Менеджер проекта, сколько контролирует, чтобы она появлялась на проекте и была актуальной.