КомпанияУслугиСтатьиСервисы

Как писать руководство пользователя? Книга Юрия Кагарлицкого

Версия для печати

Что такое Метагайд?

Метагайд — руководство по составлению руководств. Первая версия этого текста была написана Юрием Кагарлицким в 1999 году и опубликована в Интернете. Для многих технических писаталей в нашей стране Метагайд сыграл роль учебника и введения в специальность. Девять лет спустя переписанный (фактически, заново написанный) Метагайд было решено издать в виде книги.

Выходные данные

Кагарлицкий Ю. В. Разработка документации пользователя программного продукта. Методика и стиль изложения. — 2-е изд., испр. и доп. — М.: ООО «Философт Сервисы», 2012. — 232 с.

Где купить, и сколько стоит

Книга почтой

Вы можете заказать доставку книги Почтой России.

Цена одного экземпляра: 450 р.

Для того чтобы купить книгу и получить ее по почте:

  1. Отправьте ваш заказ в произвольной форме на адрес mail@philosoft.ru.

    Пожалуйста, обязательно укажите в заказе следующие данные:

    • ваши фамилию, имя, отчество;
    • ваш почтовый адрес, включая индекс;
    • количество экземпляров книги, которое вы хотели бы приобрести.

    В ответ мы пришлем вам квитанцию для оплаты книги.

  2. Оплатите заказ по квитанции, которую мы вам пришлем. Это можно сделать в отделении Сбербанка или через интернет-банк, если вы пользуетесь одним из таких сервисов.

    После этого мы отправим вам книгу Почтой России. Кроме того, мы пришлем вам код, по которому вы сможете отслеживать доставку посылки на сайте Почты России.

  3. Посылка с книгой будет доставлена вам Почтой России в течение приблизительно пяти календарных дней.

Аннотация

Задача этой книги — помочь разработчикам технической документации создавать информативные и удобные руководства для пользователей программных продуктов. В книге подробно рассматриваются различные этапы создания документации:

  • изучение программного продукта и выявление особенностей его применения;
  • определение состава комплекта документации;
  • отбор сведений, включаемых в документацию в целом и в каждый документ в отдельности;
  • составление структуры отдельного документа и ее последующая корректировка;
  • работа над текстом документации и соблюдение базовых требований к этому тексту.

Книга предназначена для технических писателей, программистов, инженеров служб технической поддержки.

Содержание

Введение
Глава 1. Постановка задачи
1.1. Действующие лица
1.2. Предмет документирования
1.2.1. Понятие программного продукта
1.2.2. Пользователь: функции и пользовательские задачи
1.2.3. Пользователи: один или много
1.2.4. Понятие пользовательской перспективы
1.3. Документация пользователя и ее характеристики
1.3.1. Понятие документации пользователя
1.3.2. Предмет документирования
1.3.3. Способы чтения документации пользователем
1.3.4. Комплект документации
Глава 2. Требования к содержанию документации
2.1. Постановка проблемы
2.2. Объективная корректность
2.3. Соответствие документа поставленным перед ним задачам
2.3.1. Требования, определяемые задачами документа
2.3.2. Актуальность
2.3.3. Полнота
2.3.4. Детальность изложения
2.4. Доступность
Глава 3. Структура документации пользователя
3.1. О структуре документации пользователя
3.1.1. Структурированность — сквозное свойство документации
3.1.2. Содержательная и формальная структура
3.1.3. Первопроходец или экскурсовод?
3.1.4. Вводные главы: торжество формальной структуры
3.1.5. Основная часть документа: способы изложения материала
3.2. Деление документа на основные структурные элементы
3.2.1. Основные структурные элементы: тематический принцип
3.2.2. Глубина и сечение формальной структуры документа
3.2.3. Парадокс формальной структуры и пути его разрешения
3.3. С плошной текст и его структура
3.3.1. Структура сплошного текста
3.3.2. Конструктивные структурные элементы
3.3.3. Маркировочные структурные элементы
3.3.4. Абзацы
3.4. Типы информации и их взаимное расположение
3.4.1. Общие принципы
3.4.2. Структурная информация 
3.4.3. Процедурно-функциональная информация 
3.4.4. Справочная информация 
3.4.5. Компоновка различных типов информации 
3.5. Проблема логического повтора
3.5.1. Повторяемость как свойство технического текста
3.5.2. Фигуры описания 
3.5.3. Логические повторы и перекрестные ссылки 
3.5.4. Логические повторы в структуре документа 
3.6. Перекрестные ссылки и случаи их использования
Глава 4. Слова и формулировки 
4.1. Словарный запас технического писателя
4.1.1. Терминология 
4.1.2. Вспомогательная терминология
4.1.3. Слова-«артикли» 
4.2. Формулировки
4.2.1. Требования к формулировкам
4.2.2. Строгость
4.2.3. Лаконичность
4.2.4. Завершенность
4.2.5. Однозначность
Глава 5. Некоторые проблемы изложения материала
5.1. Громоздкие и ветвящиеся процедуры
5.2. Порядок изложения сведений: сложные случаи
5.2.1. Проблема порядка изложения сведений
5.2.2. Курица или яйцо: рассмотрение тесно взаимосвязанных понятий
5.2.3. Канонический порядок изложения сведений
5.2.4. Унификация порядка изложения сведений
5.3. Реальное и виртуальное
5.3.1. Реальное и виртуальное в документации пользователя
5.3.2. Объекты реальности, их образы и идентификаторы
5.3.3. Люди и организации, учетные записи, имена
5.4. Образно или строго? 
5.4.1. Язык образов и его место в строгом изложении
5.4.2. Антропоморфизм и техногенность
5.4.3. Наглядные средства подачи информации

© «Философт», 2008–2017

+7 (499) 500-44-77

mail@philosoft.ru

SpyLOG