Контекстная документация
 | В этой статье есть несколько проблем. Пожалуйста, помогите улучшить его или обсудите эти проблемы на странице обсуждения . ( Узнайте, как и когда удалять эти шаблонные сообщения )
|
Контекстная документация — это информационный блок-подход к написанию документации на месте .
Это становится особенно полезным при работе с документацией на месте, поставляемой в графический интерфейс программного обеспечения , для разработки матрицы необходимой помощи пользователям в конкретной ситуации или контексте. Эта концепция основана на DITA , где при необходимости пишутся небольшие темы, задавая правильные вопросы: [1]
- Что это такое и/или что оно делает?
- Как мне его использовать?
- Есть ли у меня пример?
- Где я нахожусь с точки зрения рабочего процесса ?
- Что дальше?
- Каких ловушек следует избегать?
Это редакционная матрица, своеобразное руководство по содержанию. Ни в коем случае не следует излагать все пункты исчерпывающе, как если бы они представляли собой форму, которую необходимо заполнить. . [2]
Ссылки
[ редактировать ]- ^ Перселл, Гретхен П. (1996). Контекстные модели документов для поиска в клинической литературе . Стэнфордский университет.
- ^ О создании современной документации на Doccontents.com []