|
|
Регистрация Восстановить пароль |
Повторная активизация e-mail |
Регистрация | Задать вопрос |
Заплачу за решение |
Новые сообщения |
Сообщения за день |
Расширенный поиск |
Правила |
Всё прочитано |
|
|
Опции темы | Поиск в этой теме |
02.04.2014, 10:16 | #1 |
Старожил
Регистрация: 30.12.2009
Сообщений: 11,426
|
Документация к ПО, презентация. О чем писать, что показывать?
Доброго времени суток!
Как презентовать свою программу где-либо? О чем писать в описании, что рассказать в возможностяхи особенностях? Далее документация: О чем писать в ней, чтобыпользователю было легко читать и понимать текст? |
02.04.2014, 12:21 | #2 | |
Старожил
Регистрация: 04.02.2009
Сообщений: 17,351
|
Документация кому? Если юзеру, включайте побольше схемок, диаграмм и картинок. Не усложняйте документация навороченными словами типа конфигурация, реестр и пр. Юзер все это знать не обязан, более того это противопоказано.
Цитата:
1. Реклама возможностей (общими словами) 2. Характеристики системы, требования 3. Правила пользования, предусмотрите тупые случаи, то что для Вас очевидно, юзеру может быть непонятно (здесь также побольше картинок). 4. Раздел с действиями с внештатными ситуациями. Юзеры часто не читают написанное на экране - типа было какое-то окошко, а какое фиг знает. Распишите эти случаи 5. Контакты
Маньяк-самоучка
Utkin появился в результате деления на нуль. Осторожно! Альтернативная логика |
|
02.04.2014, 12:24 | #3 |
Старожил
Регистрация: 30.12.2009
Сообщений: 11,426
|
Документация планируется как для разработчика так и для юзера.
|
02.04.2014, 12:48 | #4 |
Старожил
Регистрация: 04.02.2009
Сообщений: 17,351
|
Тогда это два отдельных пакета документов
Маньяк-самоучка
Utkin появился в результате деления на нуль. Осторожно! Альтернативная логика |
02.04.2014, 12:50 | #5 |
Белик Виталий :)
Старожил
Регистрация: 23.07.2007
Сообщений: 57,097
|
http://tdocs.su/12535
Рекомендую придерживаться стандартов (из своего заводского опыта)
I'm learning to live...
|
02.04.2014, 12:52 | #6 | |
Старожил
Регистрация: 09.01.2008
Сообщений: 26,229
|
Ни в коем разе.
Это два разных документа и ни в коем случае не надо пытаться свести сведения для пользователя и для разработчика воедино. Что пользователю надо знать, то разработчику не особо нужно и полезно, и то, что разработчику нужно знать (структуры данных, классы (иерархия) объектов и т.п.) - то пользователю не только не нужно, но ещё и вредно. А вот раздел администирования можно включить отдельным разделом в документацию пользователя (а можно и отдельным, третьим документом сделать). Ну и ещё. Презентация и документация, это, имхо, разные вещи, для разных целей предназначенные. Успехов! p.s. всё вышесказанное является моим личным субъективным мнением (IMHO) и, разумеется, не претендует на истину в первой инстанции. p.p.s. в ГОСТе на ЕСПД говорится Цитата:
Последний раз редактировалось dr.Chas; 02.04.2014 в 20:46. |
|
02.04.2014, 12:57 | #7 | |
Старожил
Регистрация: 30.12.2009
Сообщений: 11,426
|
под презентацией, я понимаю подачу ПО пользователю на сайте.
Под документацией, .... собственно документация. Цитата:
Да, документация - истинный ад программиста. |
|
02.04.2014, 13:32 | #8 |
Старожил
Регистрация: 04.02.2009
Сообщений: 17,351
|
Документация в соответствии с ГОСТами нужно наверно не для юзера. Ну типа, там будет выставляться на торги, есть пункт в тех.задании, еще какой конкурс. Современному юзеру ГОСТовый документ будет абсолютно не читаем. Начнут закидывать какашками (при том что по ГОСТу однозначно правильно). Тут надо определиться что важней - делать для людей или "как надо".
Маньяк-самоучка
Utkin появился в результате деления на нуль. Осторожно! Альтернативная логика |
02.04.2014, 14:18 | #9 |
Старожил
Регистрация: 30.12.2009
Сообщений: 11,426
|
Для людей однозначно... проблема в том, что фанаты не умеют писать о том, от чего фанатеют
|
02.04.2014, 14:32 | #10 |
Старожил
Регистрация: 29.09.2009
Сообщений: 9,713
|
...фанаты, они разные бывають
Скачай, почитаешь, посмотришь:
Разработки и научно-технические публикации :: Видеоблог :: Твиттер
Radar systems engineer & Software developer of industrial automation |
|
Похожие темы | ||||
Тема | Автор | Раздел | Ответов | Последнее сообщение |
На чем писать? | Rashid__ | Помощь студентам | 2 | 19.11.2012 13:10 |
В чем писать? | AnthonyB | Общие вопросы C/C++ | 3 | 25.09.2011 18:25 |
на чем писать ???? | macexa | Помощь студентам | 8 | 02.04.2011 12:39 |
На чем лучше писать? | PilGrim | Свободное общение | 3 | 31.03.2009 23:45 |
На чем писать??? | Shuster | Помощь студентам | 9 | 19.01.2009 10:49 |