Просмотр исходного кода

пользовательская документация

Евгений Колесников 4 лет назад
Родитель
Сommit
b75feeb4fd
2 измененных файлов с 41 добавлено и 1 удалено
  1. 40 0
      articles/5_1_3_5.md
  2. 1 1
      readme.md

+ 40 - 0
articles/5_1_3_5.md

@@ -0,0 +1,40 @@
+# Создание руководства пользователя
+
+## Шаблон руководства пользователя по ГОСТ 34
+
+### Структура и содержание документа
+
+Требования к структуре руководства пользователя по ГОСТ 34 устанавливаются [РД 50-34.698-90](http://technicaldocs.ru/%D0%B3%D0%BE%D1%81%D1%8234/%D0%BD%D0%BF%D0%B0/%D1%80%D0%B450-34.698-90). В общем случае документ должен состоять из следующих разделов:
+
+1. Введение
+    1. Область применения
+    2. Краткое описание возможностей
+    3. Уровень подготовки пользователя
+    4. Перечень эксплуатационной документации, с которыми необходимо ознакомиться пользователю
+2. Назначение и условия применения
+    1. Виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации
+    2. Условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.)
+3. Подготовка к работе
+    1. Состав и содержание дистрибутивного носителя данных
+    2. Порядок загрузки данных и программ
+    3. Порядок проверки работоспособности
+4. Описание операций
+    1. Описание всех выполняемых функций, задач, комплексов задач, процедур
+    2. Описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур
+        1. Наименование операции
+        2. Условия, при соблюдении которых возможно выполнение операции
+        3. Подготовительные действия
+        4. Основные действия в требуемой последовательности
+        5. Заключительные действия
+        6. Ресурсы, расходуемые на операцию
+5. Аварийные ситуации
+    1. Действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств
+    2. Действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных
+    3. Действия в случаях обнаружении несанкционированного вмешательства в данные
+    4. Действия в других аварийных ситуациях
+6. Рекомендации к освоению
+
+Содержание документов является общим для всех видов АС и, при необходимости, может дополняться разработчиком документов в зависимости от особенностей создаваемой АС. Допускается включать в документы дополнительные разделы и сведения, объединять и исключать разделы.
+
+Содержание документов, разрабатываемых на предпроектных стадиях по [ГОСТ 34.601](http://technicaldocs.ru/%D0%B3%D0%BE%D1%81%D1%8234/%D0%BD%D0%BF%D0%B0/%D0%B3%D0%BE%D1%81%D1%8234.601-90), и организационно-распорядительных определяют разработчики в зависимости от объема информации, необходимой и достаточной для дальнейшего использования документов.
+

+ 1 - 1
readme.md

@@ -187,7 +187,7 @@ http://sergeyteplyakov.blogspot.com/2014/01/microsoft-fakes-state-verification.h
 
 [6+0 => 118+0]: _
 
-5. Пользовательская документация. Маркетинговая документация. 
+5. [Пользовательская документация.](./articles/5_1_3_5.md) Маркетинговая документация. 
 
 [4+0 => 122+0]: _