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

Ну почему так пессимистично?
В общем случае как раз реально - есть так называемые технологии "единый источник"
(например, Authorit, DITA). В этой технологии формируется топик (например, пункт ТЗ), на который можно ссылаться в любых других документах. Изменение этого пункта ТЗ автоматически приводит к изменению текста всех документов, в которых есть ссылка на него.



LSVДостаточно всего лишь скурпулёзно вести текстовую документацию. Не откладывать в долгий ящик. И наступит щастя.
И это правильно.
Указанные выше технологии - вещь дорогостоящая (в смысле денег и трудозатрат на их освоение и внедрение), поэтому использовать их есть смысл только при большом объеме часто изменяемой документации в течение длительного срока. Для подготовки малообъемной и малоизменяемой документации достаточно предложенной LSV технологии.

P S Для документирования программ можно использовать программы документирования, которые выискивают в исходном тексте программы специальные операторы-комментарии (которые должен вставлять программист) и на их основе формируют описание программы.