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

Вопрос:
Есть ли специализированные методы (организационные) и технические(программные) средства для подготовки документации? Как лучше это организовать? Нанять технического писателя не вариант т.к. всю специфику знает только программист и консультант на проекте.

ГОСТы отменили?

А техписатель нужен. Пусть вникает

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

(3) разве ПО поможет, описать ньюансы?
В теории считается, что документирование кода помогает понять ньюансы, но кто же код документирует и на основании этого формирует справку... И то справка для программистов получается.

(3) А ПО - будет знать _тонкие детали_?

(5) Видится что программист будет заполнять все в структурированном виде в специальном ПО, а собственно формирование файла документации будет отдельно

От такого ПО нужно только удобный редактор с возможностью экспорта в пдф и чистый немусорный html

А вообще - ibooks author

(6) не одно по не опишет тебе смысловую нагрузку и последчтвия установки той или иной галочки

(6) мы в свое время делали приблуду в 1С для автоматического формирования инструкций и поддержки из в актуальном состоянии.
зы.. СОБП было наше все))... кто знает СОБП?))

(10) Что такое СОБП ?

(11) ))) да это собственно конфа, одной из задач которой и являлась подготовка и инструкций))

Каков результат? Как работает? Решена ли в итоге задача?

(13) да, решена... и успешно в свое время эксплуатировалась. Если тут кто откликнется на СОБП - проси у него конфу))

СППР примерно для этого делали, только вот взлететь сложно.

Но это чисто документация.

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

Думается мне, что ваш проект в минус уйдет )

без специального человека не взлетит.

Программиста занять можно, конультанта тоже.
Им не до инструкций.

(17) ну зачем же спец.человек? вполне можно обойтись консультантом. а вот использование программиста для целей инструкций - очень даже сомнительная затея.

(18) Склоняюсь к той же логике

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

(20) в 1С Автоматизации коллега в свое время наваял обработку, которая выводил в Ворд любой объект конфигурации. сделайте такой же вывод в шаблон, и прилепите в конфу ветку для описания объекта "а-ля" инструкция. вполне работоспособный вариант - сам использовал.

(0) код - это и есть документ - сидишь читаешь, вникаешь в тонкости - никто подробней не расскажет как сам код :)

(22) жаль мне тех людей, которые будут по коду писать\читать инструкции...
инструкции должны идти от процессов, а не от кода..

(23) +100500
программа пишется не для программиста, а  для пользователя)