Как писать руководство пользователя

Как писать руководство пользователя

В свое время, когда появилась необходимость(и желание) написать правильное руководство пользователя, пришлось перерыть кучу литературы по теме. В процессе очень помогла статья «Как писать руководство пользователя?», в которой перебираются наверное все современные стандарты написания руководства. Для себя остановился на руководстве содержащие такие разделы:

  • Аннотация
    • Назначение документа
    • Краткое изложение основной части документа
  • Общие сведения о программе
    • Обозначение и наименование программы
    • Сведения о назначении программы
      • Информация, достаточная для понимания функций программы и ее эксплуатации
        • Возможности программы
        • Классы решаемых задач
          • Описание задач
          • Методы решения задач
        • Функции, выполняемые программой
      • Описание основных характеристик и особенностей программы
        • Временные характеристики
        • Режим работы
        • Средства контроля правильности выполнения и самовосстанавливаемости программы
      • Ограничения области применения программы
        • Сведения о функциональных ограничениях на применение
  • Условия применения программы
    • Условия, необходимые для выполнения программы
      • Сведения о технических и программных средствах, обеспечивающих выполнение программы
        • Требования к техническим средствам
          • Типы ЭВМ, устройств, используемые при работе программы
          • Минимальный и (или) максимальный состав аппаратурных и программных средств
          • Требования к составу и параметрам периферийных устройств
        • Программное обеспечение, необходимое для функционирование программы
  • Описание логической структуры
    • Алгоритм программы
    • Используемые методы
    • Сведения о структуре программы
    • Сведения о составных частях программы
    • Сведения о связях с другими программами
  • Сведения о входных и выходных данных
  • Настройка программы
    • Описание действий по настройке программы
      • Настройка на состав технических средств
      • Выбор функций
      • Поясняющие примеры
  • Дополнительные возможности
    • Описание дополнительных функциональных возможностей программы
    • Описание применения дополнительных функциональных возможностей программы

 

Как получается на практике можно посмотреть, например, руководства пользователя «Сервиса для телефонных продаж и опросов»

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *