|
Подготовка инструкций к ПО - есть ли специализированные средства/подходы? | ☑ | ||
---|---|---|---|---|
0
SerMaxim
19.10.13
✎
13:46
|
День добрый! Один из заказчиков хочет чтобы на его систему мы делали полностью документацию, стоимость документирования включена в контракт. Раньше тоже готовили документацию но как-то после разработки, сейчас доходит до того что нельзя ставить обновление если изменения не внесены в документацию.
Вопрос: Есть ли специализированные методы (организационные) и технические(программные) средства для подготовки документации? Как лучше это организовать? Нанять технического писателя не вариант т.к. всю специфику знает только программист и консультант на проекте. |
|||
1
ДенисЧ
19.10.13
✎
13:48
|
ГОСТы отменили?
|
|||
2
ДенисЧ
19.10.13
✎
13:48
|
А техписатель нужен. Пусть вникает
|
|||
3
SerMaxim
19.10.13
✎
13:55
|
(2) Скажем прямо - нерентабельно держать человека который производит текст в ворде. Такой человек вообще будет в любом случае не знать тонких деталей. Поэтому и ищем специальное ПО.
|
|||
4
pumbaEO
19.10.13
✎
14:01
|
(3) разве ПО поможет, описать ньюансы?
В теории считается, что документирование кода помогает понять ньюансы, но кто же код документирует и на основании этого формирует справку... И то справка для программистов получается. |
|||
5
Rie
19.10.13
✎
14:07
|
(3) А ПО - будет знать _тонкие детали_?
|
|||
6
SerMaxim
19.10.13
✎
14:09
|
(5) Видится что программист будет заполнять все в структурированном виде в специальном ПО, а собственно формирование файла документации будет отдельно
|
|||
7
IamAlexy
19.10.13
✎
14:13
|
От такого ПО нужно только удобный редактор с возможностью экспорта в пдф и чистый немусорный html
|
|||
8
IamAlexy
19.10.13
✎
14:15
|
А вообще - ibooks author
|
|||
9
IamAlexy
19.10.13
✎
14:17
|
(6) не одно по не опишет тебе смысловую нагрузку и последчтвия установки той или иной галочки
|
|||
10
France
19.10.13
✎
14:47
|
(6) мы в свое время делали приблуду в 1С для автоматического формирования инструкций и поддержки из в актуальном состоянии.
зы.. СОБП было наше все))... кто знает СОБП?)) |
|||
11
SerMaxim
19.10.13
✎
14:49
|
(10) Что такое СОБП ?
|
|||
12
France
19.10.13
✎
14:52
|
(11) ))) да это собственно конфа, одной из задач которой и являлась подготовка и инструкций))
|
|||
13
SerMaxim
19.10.13
✎
14:54
|
Каков результат? Как работает? Решена ли в итоге задача?
|
|||
14
France
19.10.13
✎
14:55
|
(13) да, решена... и успешно в свое время эксплуатировалась. Если тут кто откликнется на СОБП - проси у него конфу))
|
|||
15
ilpar
19.10.13
✎
14:57
|
СППР примерно для этого делали, только вот взлететь сложно.
Но это чисто документация. |
|||
16
ilpar
19.10.13
✎
14:59
|
в демке старой там проект ут 11 вродь был, там можно оценить.
Думается мне, что ваш проект в минус уйдет ) |
|||
17
ilpar
19.10.13
✎
15:00
|
без специального человека не взлетит.
Программиста занять можно, конультанта тоже. Им не до инструкций. |
|||
18
France
19.10.13
✎
15:02
|
(17) ну зачем же спец.человек? вполне можно обойтись консультантом. а вот использование программиста для целей инструкций - очень даже сомнительная затея.
|
|||
19
SerMaxim
19.10.13
✎
15:05
|
(18) Склоняюсь к той же логике
|
|||
20
SerMaxim
19.10.13
✎
15:05
|
думал последовательность будет такой: Программист быстро пишет заготовку (или она формируется автоматически) т.к. стараемся чтобы все задачи были записаны, консультант дальше начинает наводить марафет
|
|||
21
France
19.10.13
✎
15:09
|
(20) в 1С Автоматизации коллега в свое время наваял обработку, которая выводил в Ворд любой объект конфигурации. сделайте такой же вывод в шаблон, и прилепите в конфу ветку для описания объекта "а-ля" инструкция. вполне работоспособный вариант - сам использовал.
|
|||
22
EvgeniuXP
19.10.13
✎
15:10
|
(0) код - это и есть документ - сидишь читаешь, вникаешь в тонкости - никто подробней не расскажет как сам код :)
|
|||
23
France
19.10.13
✎
15:11
|
(22) жаль мне тех людей, которые будут по коду писать\читать инструкции...
инструкции должны идти от процессов, а не от кода.. |
|||
24
Конфигуратор1с
19.10.13
✎
16:01
|
(23) +100500
программа пишется не для программиста, а для пользователя) |
Форум | Правила | Описание | Объявления | Секции | Поиск | Книга знаний | Вики-миста |