среда, 11 марта 2015 г.

[prog.doc] В минутку передыха при написании документации...

Одна из самых тяжких работ в программировании -- это написание документации. Особенно на языке потенциального противника. Особенно, когда знание этого языка где-то на уровне "Do you speak English?" -- "Nicht Verstehen" ;)))

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

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

При этом, как бы ни было тяжело, написание документации -- это важно. Зачастую именно при написании документации находишь пути для улучшения того, что было сделано. А иногда обнаруживались несоответствия с тем, что именно требовалось сделать. Бывали и случаи, когда описывая поведение того или иного класса/метода всплывали серьезные ошибки в реализации. Да и вообще, в условиях, когда приходится работать "многостаночником", навык документирования оказывается крайне полезен.

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

Однако, как бы то ни было, раздел под названием "Some Technical Details" настоятельно просит быть написанным. Хотя бы в черновом варианте :))) Так что возвращаюсь к своим баранам :)

Отправить комментарий