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

Posted by Chas under Общалка

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

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

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

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

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

Успехов!

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

тема на форуме

Похожие статьи

• Программа для добавления кода в документацию