Справочная система к ПО (Help обыкновенный)
- Войдите на сайт для отправки комментариев
Существуют ли конкретные требования к содержанию Справочной системы?
Есть Руководство пользователя, включающее введение, полное описание интерфейса, описание всех команд управления, описание всех возможных пользовательских операций, глоссарий, системные сообщения и прочая, и прочая...
Теперь необходимо подготовить Help.
Хотелось бы разобраться, чем принципиально отличается Help от Руководства (кроме формата и способа использования).
Можете ли подсказать насчет стандартов такого рода "документации"?
Заранее благодарю!
ЗЫ. Технические средства подготовки не интересуют, нужна помощь именно по наполнению Справки.
На мой взгляд, хороший хелп должен включать в себя...
Еще одним отличием хелпа от Руководства должна являться хорошо продуманная система перекрестных ссылок как в тексте, так и в конце каждого подраздела (имеются в виду элементы "Смотри также:"). Ну и наконец, отсутствие "воды"...
...Лично я, считаю наиболее удачными справочные системы продуктов от Macromedia.
Вот спасибо!!
Именно то веское аргументированное мнение, которого мне недоставало!
И Macromedia обязательно посмотрю - сама неоднократно обращалась к help для DreamWeaver (и своих редакторов туда посылала ), и всегда находила там ответ (еще когда на тему тех.райтерства даже не задумывалась)
Есть Руководство пользователя, включающее введение, полное описание интерфейса, описание всех команд управления, описание всех возможных пользовательских операций, глоссарий, системные сообщения и прочая, и прочая...
Теперь необходимо подготовить Help.
На мой взгляд, хороший хелп должен включать в себя:
1. Tutorials, где на пальцах объясняются базовые функции, приемы работы и основные элементы интерфейса - я, по крайней мере, всегда начинаю знакомство с программой именно с этого.
2. Подробные описания интерфейса, функций, операций и прочего (что там нужно?).
3. Хорошо продуманный глоссарий (редко встречается).
4. Индекс и система поиска.
Еще одним отличием хелпа от Руководства должна являться хорошо продуманная система перекрестных ссылок как в тексте, так и в конце каждого подраздела (имеются в виду элементы "Смотри также:"). Ну и наконец, отсутствие "воды", типа Введения, Назначение, Условия выполнения, Характеристика и проч. разделов, предназначенных для прокуроров и всяких ревизоров.
Комплексом стандартов по автоматизированным системам управления, в частности, ГОСТ 34.201-89 ВИДЫ, КОМПЛЕКТНОСТЬ И ОБОЗНАЧЕНИЕ ДОКУМЕНТОВ ПРИ СОЗДАНИИ АВТОМАТИЗИРОВАННЫХ СИСТЕМ, а также комплексом стандартов ЕСПД документ HELP (Справочная система) не определен
Насколько я знаю, он не регламентируется и зарубежными стандартами.
например: http://www.author-it.com .
Вот этот пример я бы не рекомендовал - хелп у AuthorIt'а кривоват...
Лично я, считаю наиболее удачными справочные системы продуктов от Macromedia.
Комплексом стандартов по автоматизированным системам управления, в частности, ГОСТ 34.201-89 ВИДЫ, КОМПЛЕКТНОСТЬ И ОБОЗНАЧЕНИЕ ДОКУМЕНТОВ ПРИ СОЗДАНИИ АВТОМАТИЗИРОВАННЫХ СИСТЕМ, а также комплексом стандартов ЕСПД документ HELP (Справочная система) не определен. А посему получается, что разрабатывать его следует на основе здравого смысла и по аналогии с разработками ведущих фирм, например: http://www.author-it.com .
- Войдите на сайт для отправки комментариев
Help обыкновенный - helpes vulgaris Пора переходить на латынь