Здравствуйте, уважаемые!

Столкнулся (ожиданно) с одной задачкой и пока не до конца представляю как её лучше решить.

Есть один проект, заказчиком которого являлась родная компания. Над проектом более полугода трудятся 3-е человек, я (пм) и 2 разработчика.
Пишем web based арм (iis+asp.net+C#+mssql).
Собственно когда все начиналось, стояли жесткие сроки и у руководства не было никакого желания делать все по уму (т.з., документация и и т.д.), поэтому проект делался и делается на коленке.

На данный момент принято решение заниматься развитием проекта и его коммерциализацией, соответственно стоит задача перевести все на цивилизованные рельсы -  как минимум  нужно всё задокументировать.

У текущих разработчиков довольно большая загрузка и roadmap на полгода вперед, да и к документированию они не шибко приспособлены.
По сему, руководство предложило взять в штат внутреннего документатора, в задачи которого будет входить составление документации на весь проект.

Предполагается, что результатом его (документатора) работы будет некий набор документов, ознакомившись с которым, толковый оутсорсер  или новый человек в штат, без проблем сможет дописать новый модуль или имея доступ к исходникам, на лету поправить доработать старый.
Поправьте пожалуйста, если я не прав.

Проблема в том, что с документацией такого рода я раньше не сталкивался, как и с людьми которые такую документацию в силах создавать.
Поэтому есть ряд вопросов.

Самый неоднозначный - требования к человеку.
Предположительно это должен быть человек с грамотным русским, знаниями и опытом применения UML, знающий asp.net+C#+mssql как минимуму на начальном уровне (что бы не висеть постоянно на разработчиках), довольно скрупулезный и внимательный.
Так?

Если да, то как мне кажется, такого специалиста будет довольно сложно найти на вменяемые деньги.


В итоге получается такая вот выжимка вопросов:
1. Насколько верны мои ожидания по поводу результатов деятельности документатора?
2. Какими навыками должен обладать документатор (уровень знания технологии, софт) и что это вообще за человек?
3. Сколько может стоить такой документатор в офис/Москва
4. Сколько приблизительно займет по времени работа документатора над проектом, с учетом того, что исходники ( код+разметка) весят в районе 2mb?
5. Есть ли смысл рассматривать удаленку по этому направлению?

Буду очень признателен за ответы по теме!
Спасибо!

Правильно.


ИМХО, систему должна документировать команда. Кто как ни они лучше всех это сделает?


По ходу, это программист уровня senior software engineer.


Трудно судить.


Теоретически возможно, но нужно учитывать, что этому челу придется очень много общаться с разработчиками. Поэтому и для них надо выделить в день часа 2-3 на коммуникацию. 

Беда в том что команда документированием никогда не занималась, да и времени на это нет совсем..


Мде, т.е. такой "документатор" нам обойдется от 3-х кб? 
Дороговато однако...

Ты как менеджер должен понимать, что для вывода продукта на рынок есть ряд непрограммерских задач. Плюс, public product в разработке занимает в 3 раза больше времени, чем такая же система, но для внутреннего использования.

Добавлено через 1 минуту и 12 секунд

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

Команда должна действительно писать документацию, но приводить документацию в порядок должен специальный человек. В принципе не очень критичен его уровень владения технологиями, но понимать их он должен. Также он действительно должен быть скрупулезным и внимательным к мелочам. 

Разработчики вряд ли напишут хорошую документацию. Поэтому я считаю нужен план документации утвержденный ключевыми фигурами и разработчики пусть пишут базовую часть документации, а контролирует и составляет (пишет сам или берет заготовки разработчиков) итоговый документ специально выделенный человек.

А любой профессионал стоит дорого - это факт!

p/s
Интересно есть какиенибудь статьи (русский/английский) с описанием как превратить плохой процес разработки в хороший, какие проблемы при этом возникают. Ведь нет пределов совершенству

M arilou

задайте этот вопрос в отдельном топике

Это сообщение отредактировал(а) arilou - 16.4.2008, 15:02

Соррри а DoxyGen вы не использовали?

А какие требования к документации? какие сроки?
Я не верю чт оприйдет со стороны человек и все задокументирует, в карайнем случае эт ополучится бумажка ради бумажки.
Вообще вс е зависит от того ЧТО и в каком объеме должно быть в документе?
причем документирование должны заниметься и прграммисты и тестеры и постновщики задачи. 
Если документ пойдет наружу., типа юзермануал, то да тут нужен технический писатель.

Это коммуникабельный грамотный человек на уровне Junior Developer или выше. Его задачи - понимать ООП и грамотно писать по-русски или по-английски (зависит от того, на каком языке нужна дока). 

Дальше на примере Харькова. Найти джуниора, который может грамотно писать по-английски очень трудно, так как все считают свой уровень достаточным, а на деле это дай бог чтобы intermediate. Найти джуниора, который может грамотно писать по-русски значительно легче, но есть проблема: все они хотят быть программистами, а не докописателями, так что будут кадровые проблемы через некоторое время.