Система построения проекта

Существует определённая система построения больших программных проектов. Сначала составляется детальный план работы вплоть до перечисления всех диалогов и реакций программной системы на любые события, будь то нажатие клавиш клавиатуры или аварийные состояния, а уже потом кодируется, реализуется сама система. Часто на создание такого документа уходит не один месяц. Программисты не любят ждать и, как правило, ненавидят писать всевозможные технические задания, планы работы и описания проектов. Им это просто неинтересно. Однажды мне пришлось за короткий срок создать подробное (страниц на 25—30) руководство для пользователей к собственному текстовому редактору. Этот труд оказался сложнее, чем разработка самой системы.Казалось бы, что может быть сложного в описании работы собственной программы, т. е. её интерфейса.

Однако руководства, написанные самими авторами программ, редко бывают хорошими. Люди не знают, как подать материал. С этим лучше справляются профессионалы — технические писатели.Технический писатель должен не столько обладать литературным даром, сколько разбираться в программировании и в принципах интерфейса. Если писатель не разбирается в конкретных деталях работы программы, то это не столь большая беда, однако понимание сути проекта так же важно, как, допустим, естественно-научное образование для редактора биологических текстов. Базовое образование технического писателя — техническое или университетское.