Руководство пользователя: избавление от «старообразности» заголовков разделов
Указанная задача также требует разъяснений, поскольку один и тот же заголовок раздела руководства пользователя, структура которого (в целом) сформирована в первой части статьи, может трактоваться неоднозначно или попросту вызывать недоумение. К примеру, раздел «Входные точки в программу».
Руководство пользователя: компромиссный вариант структуры
Компромиссный вариант структуры руководства пользователя должен устраивать «и наших, и ваших»:
- «наших» - удовлетворять требованиям ГОСТ 19 серии (здравого смысла);
- «ваших», включая:
- рекомендации IEEE Std 1063-2001 (для любителей всего «модненького-заграничненького»);
- рекомендации манифеста Кагарлицкого (для любителей изящного, изысканного построения фраз);
- фантазии «технических писателей всех времен и народов», коим техническая документация, разработанная согласно требований «увесистого тома ГОСТ 19», кажется «составленной непонятно и дурно».
Компромиссный вариант, по мере его формирования (в табличке), и предлагается к обсуждению.
Компромиссный вариант структуры разделов руководства пользователя
Цифры 1, 2 и т.д. соответствуют уровню вложенности заголовка.
Наименование раздела (подраздела) | П | З |
(1) Введение | Н | Н |
(2) Назначение документа | Р | Н |
(2) Краткое изложение основной части документа | Р | Н |
(1) Общие сведения о программе | Р | Н |
(2) Обозначение и наименование программы | О | Н |
(2) Языки программирования, на которых написана программа | О | О |
(2) Назначение программы | Р | Н |
(2) Возможности программы | Р | Н |
(3) Классы решаемых задач | О | О |
(3-4) Описание задач | Р | Н |
(3-4) Методы решения задач | О | Р |
(3) Функции, выполняемые программой | Н | Н |
(2) Описание основных характеристик и особенностей программы | Н | Н |
(3) Временные характеристики | Р | Н |
(3) Режим работы | О | Н |
(3) Средства контроля правильности выполнения и самовосстанавливаемости программы | Н | Н |
(2) Ограничения области применения программы | Н | Н |
(3) Сведения о функциональных ограничениях на применение | Н | Н |
(1) Условия применения программы | Н | Н |
(2) Условия, необходимые для выполнения программы | Н | Н |
(3) Сведения о технических и программных средствах, обеспечивающих выполнение программы | Н | Н |
(3) Требования к техническим средствам | Н | Н |
(4) Виды ЭВМ, устройств, используемых программой | Н | Н |
(4) Минимальный состав технических средств | Н | Н |
(4) Требования к составу и параметрам периферийных устройств | Н | Н |
(3) Программное обеспечение, необходимое для функционирования программы | Н | Н |
(4) Требования к программному обеспечению | Н | Н |
(4) Требования к другим программам | Н | Н |
(3) Требования и условия организационного, технического и технологического характера | Н | Н |
Введение
В разделе: Назначение документа Краткое изложение основной части документа |
По ГОСТ 19 раздел старообразно называется Аннотацией. Пусть будет Введением. Противоречий с IEEE Std 1063-2001 нет, поскольку имеет место Introduction.
Дата добавления: 2016-04-14; просмотров: 505;