суббота, 10 ноября 2012 г.

Техническая документация

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

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

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


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

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

А вы подробную документацию ведете?

1 комментарий: