Услуги Сертификаты Новости Статьи База знаний Алгоритмы Портфолио Скачать Ссылки Поиск
Услуги arrow Новости arrow Написание документации к проекту: кому её писать?
Написание документации к проекту: кому её писать? Версия для печати Отправить на e-mail
18.03.2010

Вопрос в следующем: кто должен писать эту самую документацию? 
Технический писатель, программисты, системный аналитик? Или вообще не писать?

Вообще без документации не обойдется - заказчик, думаю, будет против.
Остается решить, кто станет жертвой и взвалит себе на плечи этот непомерный труд. В какой-то мере, это действительно непомерный труд.

Итак, хочу рассмотреть плюсы и минусы каждой кандидатуры:
1. Технический писатель.
Плюсы: это человек, который самой судьбой избран быть автором данного труда. Он по сути для того и создан природой - сидеть и кропотливо трудиться над документацией, когда все уже разошлись по домам.
Но, минус в том, что данный сотрудник не всегда владеет "темой" разработки, т.е. не всегда может адекватно понимать, как работают те, или иные части информационной системы. Отсюда проблемы в адекватности документации - она может не на 100% отображать суть работы алгоритмов.

2. Системный аналитик. 
Это человек, который должен знать суть. Суть работы приложения, составлять изначально техническое задание и быть самым осведомленным участником процесса разработки о том, что же команда разработчиков должна закодить. Но... Как обычно, толкового системного аналитика, чтобы еще не был лентяем, найти трудно. Можно, но он как тот суслик за деревом. В принципе, он там есть, но по факту...

3. Программист(ы)
Идеальная "жертва". Но! Стоимость часа работы программиста слишком дорогое удовольствие, чтобы его привлекать к разработке документации. Хотя, это те люди, которые лучше всего понимают, как же работает написанное ими же приложение!
Вот и получается, что по всем раскладам, документацию придется писать им... если, конечно, мы хотим всё же получить документацию.
Как бы ни были программисты дороги. 
Правда, как всегда, есть нюанс... Программисты не всегда четко могут выразить свои мысли на бумаге...
Ну, кто сказал, что гениальный художник обязан не менее гениально писать очерки. А документация, это в какой-то мере очерк. О новом приложении.

Как решить эту проблему? Как написать хорошее приложение и замечательную документацию? 
Идеально - искать людей универсалов.
В реальности - заставить этих троих (см. выше) работать вместе.
Технический писать пишет то, что ему сказал системный аналитик. 
Системный аналитик "берет за горло" программиста и вытягивает из него информацию о тех моментах, которые не ясны ему и тем более, не ясны техническому писателю.
Программист всячески должен сопротивляться, конечно же, таким притеснениям и насилию со стороны аналитика, но все же понимать, что без его консультаций дело не стронется с места.

Вот и получается, только команда может создать шедевр. И не важно, относится ли это к самому приложению, или к его документации. В одиночку ничего не получится.
Удачного вам кодинга!

Эту же статью Вы могли бы прочитать тут.

 
< Пред.   След. >