Документация к ПО, презентация. О чем писать, что показывать?

[Человек_Борща]

Доброго времени суток!

Как презентовать свою программу где-либо?
О чем писать в описании, что рассказать в возможностяхи особенностях?

Далее документация:
О чем писать в ней, чтобыпользователю было легко читать и понимать текст?

[Utkin]

Документация кому? Если юзеру, включайте побольше схемок, диаграмм и картинок. Не усложняйте документация навороченными словами типа конфигурация, реестр и пр. Юзер все это знать не обязан, более того это противопоказано.

О чем писать в описании, что рассказать в возможностяхи особенностях?

Составьте себе неформальное оглавление, типа:
1. Реклама возможностей (общими словами)
2. Характеристики системы, требования
3. Правила пользования, предусмотрите тупые случаи, то что для Вас очевидно, юзеру может быть непонятно (здесь также побольше картинок).
4. Раздел с действиями с внештатными ситуациями. Юзеры часто не читают написанное на экране - типа было какое-то окошко, а какое фиг знает. Распишите эти случаи
5. Контакты

[Человек_Борща]

Документация планируется как для разработчика так и для юзера.

[Utkin]

Тогда это два отдельных пакета документов

[Stilet]

http://tdocs.su/12535
Рекомендую придерживаться стандартов (из своего заводского опыта)

[Serge_Bliznykov]

Сообщение от Человек_Борща

Документация планируется как для разработчика так и для юзера.

Ни в коем разе.
Это два разных документа и ни в коем случае не надо пытаться свести сведения для пользователя и для разработчика воедино.
Что пользователю надо знать, то разработчику не особо нужно и полезно, и то, что разработчику нужно знать (структуры данных, классы (иерархия) объектов и т.п.) - то пользователю не только не нужно, но ещё и вредно. А вот раздел администирования можно включить отдельным разделом в документацию пользователя (а можно и отдельным, третьим документом сделать).

Ну и ещё. Презентация и документация, это, имхо, разные вещи, для разных целей предназначенные.

Успехов!

p.s. всё вышесказанное является моим личным субъективным мнением (IMHO) и, разумеется, не претендует на истину в первой инстанции.

p.p.s. в ГОСТе на ЕСПД говорится

2.3. Виды эксплуатационных документов и их содержание приведены в табл. 3.

Таблица 3

Вид эксплуатационного документа Содержание эксплуатационного документа
Ведомость эксплуатационных документов Перечень эксплуатационных документов на программу
Формуляр Основные характеристики программы, комплектность и сведения об эксплуатации программы
Описание применения Сведения о назначении пpoгpaммы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств
Руководство системного программиста Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения
Руководство программиста Сведения для эксплуатации программы
Руководство оператора Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы
Описание языка Описание синтаксиса и семантики языка
Руководство по техническому обслуживанию Сведения для применения птестовых и диагностических программ при обслуживании технических средств

[Человек_Борща]

под презентацией, я понимаю подачу ПО пользователю на сайте.
Под документацией, .... собственно документация.

Это два разных документа и ни в коем случае не надо пытаться свести сведения для пользователя и для разработчика воедино.

Таки да, мои грабли

Да, документация - истинный ад программиста.

[Utkin]

Документация в соответствии с ГОСТами нужно наверно не для юзера. Ну типа, там будет выставляться на торги, есть пункт в тех.задании, еще какой конкурс. Современному юзеру ГОСТовый документ будет абсолютно не читаем. Начнут закидывать какашками (при том что по ГОСТу однозначно правильно). Тут надо определиться что важней - делать для людей или "как надо".

[Человек_Борща]

Для людей однозначно... проблема в том, что фанаты не умеют писать о том, от чего фанатеют

[raxp]

...фанаты, они разные бывають

Скачай, почитаешь, посмотришь: