Недавно я уже высказывался по вопросам какая документация нужна, и решил добавить еще пару копеек.
Итак - а кому нужна вообще документация? Ведь первый повод отказа от документирования - звучит именно так: "Ее все равно никто не будет читать кроме автора!"
Документация нужна:
Итак - а кому нужна вообще документация? Ведь первый повод отказа от документирования - звучит именно так: "Ее все равно никто не будет читать кроме автора!"
Документация нужна:
- для проведения экспертизы проектных решений. Это - в первую очередь это Гос. Заказчик, потом - менеджер проекта, архитектор. Тут надо понимать, что если вы делаете что-то для большого холдинга, то центральный аппарат в глаза не видит вашу АС и оценивает ее только по бумаге. И денежки платит на основании этой бумаги.
- для проведения проверок на соответствие регулирующим органам (например - персональные данные, требования ФСБ, БАЗЕЛЬ-2). Это - представители государственных регуляторов и аудиторы. И здесь понятно зачем нужна документация - аудитор в первую очередь изучает проектные решения, которые подтверждают выполнение его требований. И если ТРП нет, то вы хоть убейтесь, но не докажете что вот в этой АС персональные данные не обрабатываются.
- для обеспечения рабочего взаимодействия при разработке. Это - сами разработчики, архитектор, тестировщики, аналитики. Документация данного уровня должна в первую очередь являться базой знаний и содержать описания общих для проекта спецификаций: спецификаций классов, интерфейсов, словарей данных, информационной модели. Неплохо тут работает UML и вики представление. Эту документацию делать надо если у вас в команде больше 3-5 программистов и заказчику ее можно не показывать -).
- для обеспечения возможности эксплуатации системы. Это - сисадмины заказчика и саппортеры исполнителя. Состав этой документации достаточно прост, оптимальный формат представления - справочник, но ее разработка достаточно тяжела, если у вас нет документации из предыдущего пункта. Чаще всего в реальной жизни эксплутационной документации как раз и не хватает -(
- для обеспечения возможности работы с системой. Это - пользователи и админы. Формат - те самые руководства пользователя
Комментариев нет:
Отправить комментарий