Основные виды технической документации. Лекция_10. Лекция 10. Основные виды технической и технологической документации
 Скачать 0.71 Mb.
|
|
1 Лекция №10. Основные виды технической и технологической документации Под технической документацией принято понимать обобщённое название графических и текстовых документов, в которых зафиксированы технические идеи и решения. Технологическая документация — совокупность графических и текстовых технических документов, которые отдельно или в комплексе определяют процесс изготовления изделий промышленного производства или процесс сооружения объектов капитального строительства. Номенклатура технологической документации определяется ГОСТ и ЕСТД, входящими в систему унифицированной документации. Техническая документация на программный продукт (программу) разрабатывается в соответствии с требованиями ГОСТ ЕСПД и её можно разделить на следующие категории: Программная документация – документация, содержащая сведения, необходимые для разработки, изготовления, эксплуатации и сопровождения программы (программного изделия). Эксплуатационная документация – документация, необходимая для обеспечения функционирования и эксплуатации программного изделия. Различают следующую документацию на программный продукт Спецификация Состав программы и документации на нее Ведомость держателей подлинников Перечень предприятий, на которых хранят подлинники программных документов Текст программы Запись программы с необходимыми комментариями Описание программы Сведения о логической структуре и функционировании программы Программа и методика испытаний Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля Техническое задание Назначение и область применения программы, технические, технико- экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний Пояснительная записка Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений Эксплуатационные документы Сведения для обеспечения функционирования и эксплуатации программы Виды эксплуатационной документации и требования к ней Ведомость эксплуатационных документов Перечень эксплуатационных документов на программный продукт Формуляр Основные характеристики программы, комплектность и сведения об эксплуатации программы Описание применения Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств Руководство системного программиста Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения Руководство программиста Сведения для эксплуатации программы Руководство оператора Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы Описание языка Описание синтаксиса и семантики язык Руководство по техническому обслуживанию Сведения для применения тестовых и диагностических программ при обслуживании технических средств 2 Описание программы и описание применения Данный документ относится к типу программно-эксплуатационной. Применяется к программе, комплексу, ПАК, программному компоненту или системе. Целевая аудитория: лица, которые принимают решение о покупке и вводе в эксплуатацию программы. Документ содержит информацию о функциональных возможностях программы и сфере её применения. Структуру и оформление документа определяется в ГОСТ 19.105-78 Информационная часть (аннотации и содержания) в соответствии с ГОСТ 19.502-78 Документ необходим для информирования потенциальных пользователей и покупателей о назначении программы и способах применения. Больше подходит для менеджеров (специалистов, системных администраторов), которые самостоятельно принимают решение о приобретении программы и вводе её в эксплуатацию. Всю необходимую информацию они смогут получить из этого документа: описание программы и ее применение. В описании программы и описании применения указываются: Задачи, которые решает программа; Затрачиваемые ресурсы для работы; Вводная информация; Выходные данные. Акцент делается на описательной части программы, её функциях и назначении. В меньшей степени на описании применения. Делается описание именно о возможностях программы и задач, которая она решает, а не её внутреннего устройства. При определённых особенностях программы допускается объединять разделы или вводить новые (дополнительные). Структура описания программы (ГОСТ 19.402-78): 1. Общие сведения. 2. Функциональное назначение программы. 3. Описание логической структуры. 4. Технические средства, которые используются. 5. Вызов и загрузка. 6. Входные данные. 7. Выходные данные. Структура описания применения (ГОСТ 19.502-78): 1. Назначение программы. 2. Условия применения. 3. Описательная часть задачи. 4. Входные и выходные данные. 5. приложения (таблицы, иллюстрации и т.д.). Программа и методика испытаний Программа и методика испытаний – это документ, входящий в комплект конструкторской документации, составляемой на автоматизированную систему или программу на стадии разработки. Программа методики испытаний призвана установить технические данные, которые подлежат проверке во время испытаний всей системы в целом или ее отдельных компонентов. Этим документом устанавливается порядок опытов и способы контроля их результатов. Согласно руководящему документу РД 50-34.698-90 , в этом документе перечисляются все проверки, призванные установить эффективность проектных решений, выявить причины отказов или сбоев, определить качество проведенных работ, проверить соответствие АСУ технике безопасности, а также устанавливается продолжительность всех опытов, их режим и прочее. 3 Программа и методика испытаний содержит перечень необходимых проверок, проводимых во время испытаний. К таким проверкам обычно относится: Проверка соответствия техзаданию; Проверка комплектности системы; Проверка комплектности и качества документации; Установление достаточности, комплектности и качества программной поддержки и документации на нее; Установление квалификации обслуживающих работников; Проверка соответствия системы требованиям функционального назначения; Установление пригодности системы к контролю; Выявление нарушений техники безопасности, санитарии, эргономики; Проверка взаимодействия системы с другими программными средствами. Согласно государственному стандарту ГОСТ 19.301-79 , документ «программа и методика испытаний» оформляется в соответствии с ГОСТ 19.105-78 (общими требованиями к оформлению программных документов) и должен содержать следующие разделы: Объект испытаний, с указанием наименования, области применения, обозначения АСУ. Цель испытаний, с указанием конкретных данных, которые должны быть получены по результатам опытов. Требования к программе. Содержит перечень требований, которые заданы тех заданием и должны быть проверены опытным путем. Требования к программным документам, с перечислением состава документов и особых требований на испытания системы, установленных ТЗ. Средства и порядок испытаний, с указанием технических и программных средств, использующихся для проведения испытаний, и порядка опытов. Методы испытаний. Описание применяемой методологии, с перечнем данных, которые должны быть получены во время проведения испытаний. Приложения. Программы и методики испытаний могут содержать дополнительные материалы – графики, таблицы, тестовые примеры и их контрольные распечатки. Согласно ГОСТ 19.301-79 , информационную часть – аннотацию, содержание и прочее – на такой документ, как программа и методика испытаний, можно не оформлять. Техническое задание на программу (ПО) Техническое задание (ТЗ) — исходный документ, который является основанием для разработки и испытания программы или автоматизированной системы. Техническое задание на программу и программное обеспечение разрабатывается в соответствии с требованиями ГОСТ 19.201-78 . Основанием для разработки ТЗ чаще всего является договор. ТЗ на программу разрабатывается, прежде всего, для тех людей, которые в последствии будут разрабатывать программный продукт. Как и любое другое ТЗ на программу должно быть предельно ясно и не содержать двусмысленные формулировки и должно максимально полно описывать все требования и пожелания Заказчика к создаваемой программе, но при этом не стоит забывать, что программисты люди творческие и освоить 150 листов технического текста им не всегда под силу. Хочется акцентировать внимание на часто совершаемой ошибке – поручить написание технического задание на программный продукт программисту, обосновывая тем, что программисту будет проще потом реализовывать собственное техзадание. Техническое задание на программу должно разрабатываться техническим писателем! Во- первых, помимо знания ГОСТ 9.301-79 , необходимо знание и других стандартов (например, ГОСТ 19.106-78, ГОСТ 19.104 – 78 и др.), не многие программисты знают эти ГОСТы, а ещё меньше согласятся их изучить. Во-вторых, необходимы знания и опыт владения техническим письменным языком (не путать с написанием кода программного обеспечения). В-третьих, только 4 совместно работающая команда (технический писатель, программист, менеджер проекта) смогут вместе разработать полноценное техническое задание на программу и программное обеспечение. Состав разделов техзадания на программу указан всё в том же ГОСТ 19.201–78 (п.1.4). введение; основания для разработки; назначение разработки; требования к программе или программному изделию; требования к программной документации; технико-экономические показатели; стадии и этапы разработки; порядок контроля и разработки; в техническое задание допускается включать приложения. В стандарте очень чётко описан состав ТЗ на программное обеспечение, но в тоже время стандарт (всё тот же п.1.4) даёт поле для творчества разработчику Технического задания. Пояснительная записка к техническому проекту Пояснительная записка к техническому проекту - это один из основных документов, входящих в число документации, составляемой на этапе технического проектирования. В пояснительной записке содержатся общие сведения о проектируемой системе, обоснования технических решений, которые были выбраны для ее создания, а также план действий, благодаря которым планируется ввести систему в эксплуатацию. Пояснительная записка оформляется согласно межгосударственному стандарту ГОСТ 2.106-96 , описывающему общие требования к составлению текстовой и конструкторской документации, содержание ее разделов описано в руководящем документе РД 50-34.698-90 , регламентирующем требования к содержанию документов на АСУ. Этот документ, согласно стандартам и руководящим документам, должен состоять из нескольких разделов: «Общие положения» - С указанием названия разрабатываемой АСУ, документов, на основании которых система разрабатывается – технического задания, договора - организаций, которые принимают участие в проектировании, стадий и сроков выполнения работ, целей разработки системы, ее назначения и сферы применения, технической и нормативной документации, а также очередности работ по проектированию. «Описание процесса деятельности» - Пояснительная записка к техническому проекту содержит общие сведения о функционировании разрабатываемой системы. «Базовые технические решения» - Приводится структура системы с перечнем подсистем, способов и средств обмена компонентов системы данными, взаимосвязи АС с другими системами, режимов функционирования. Также здесь следует перечислить квалификацию и количество работников, функции системы, технические средства, обеспечивающие ее работу, потребности в информационном и программном обеспечении. «Действия по подготовке системы к эксплуатации» - Приводится список работ по подготовке персонала, приведения выходных данных системы к пригодному для дальнейшего использования виду, организации мест работы, а также других мероприятий, отвечающих специфике ввода в эксплуатацию конкретной системы. Пояснительная записка, служащая для пояснения и перечисления практически всех работ, произведенных во время технического проектирования, составляется на любую программу или автоматизированную систему управления. Вместе с тем, разработка пояснительной записки сама по себе является важным этапом технического проекта, избежать которого невозможно. 5 Разработка эксплуатационной документации Эксплуатационная документация составляется на те изделия, использование которых связанно с определенной спецификой. В частности, это программное и аппаратное обеспечение. Такие документы существенно упрощают эксплуатацию продукции, способствуют оптимизации рабочих процессов, влияют на качество работ. Данная документация входит в состав технической документации, которая в обязательном порядке составляется на все технические изделия и объекты по ГОСТ. Разработка эксплуатационной документации на программный продукт или техническое средство должна проводиться грамотными, подготовленными специалистами, компетентными в области информационных технологий. Нами проводится тщательный и скрупулезный анализ всех нюансов конкретного изделия, на которое разрабатывается документы. Наши специалисты делали это уже не раз, а потому знают специфику составления и требования контролирующих госструктур, а также все нормы соответствующих стандартов, которыми регламентируются правила выполнения конструкторской документации. При использовании эксплуатационной документации по ГОСТ существенно снижаются: Затраты на повышение квалификации персонала Уровень некомпетентности работников, эксплуатирующих конкретный продукт Риск неправильных действий в случае внештатных или аварийных ситуаций Уровень эксплуатационных расходов Кроме этого, повышается срок службы и общий уровень надежности техники или программных продуктов, которые снабжены полным пакетом документов, вследствие правильного использования персоналом. Нами производится разработка эксплуатационной документации стандартного образца – формуляра, паспорта , монтажных и установочных инструкций, но этот пакет может быть дополнен также специальными документами: Общим системным описанием Ведомостью документации по эксплуатации Руководством по эксплуатации Программой и методикой испытаний Руководством администратора Руководством системного администратора Руководством программиста Руководством системного программиста Руководством оператора Ведомость эксплуатационных документов Ведомость эксплуатационных документов (сокращенно ВЭ) – это документ, входящий в пакет эксплуатационной документации и регламентирующий ее комплектность, наименования и правила хранения. Составление данного документа на разработанную автоматизированную систему или программу предусмотрено ГОСТ 34.201-89 Ведомость документации по эксплуатации оформляется согласно стандарту ГОСТ 19.105- 78 , описывающему общие требования к составлению программной документации. Данный документ может как содержать информационную часть так и не содержать ее, в зависимости от специфики разрабатываемой системы и требований заказчика. Ведомость на эксплуатационные документы состоит из двух разделов: «Документация на программу» - В котором приводится перечень всей необходимой эксплуатационной документации, кроме собственно ВЭ. «Документация на составные элементы программы» -В котором перечисляются ВЭ на те программы, из которых непосредственно состоит данная. 6 В случае если этот документ разрабатывается для компонента, который будет применяться самостоятельно – второй раздел не составляется. Ведомость эксплуатационных документов составляется согласно специальной форме, приведенной в третьем пункте приложения 1 стандарта ГОСТ 19.507-79 . Список документации вносится в графу «наименование», под заголовки разделов, перечисляется она в порядке возрастания кода. Ведомость содержит следующие графы: «Обозначение», с указанием обозначений всей документации, взятых из ГОСТ 19.103-77 «Наименование», с указанием полного названия данного документа, которое должно соответствовать наименованию, указанному на титульном листе. «Количество экземпляров». «Местонахождение», с указанием номеров папок, в которых хранится печатная документация. Также ведомость может быть дополнена необходимыми примечаниями и сведениями в том случае, если они поясняют некоторые нюансы, связанные с эксплуатационной документацией. В случае если таких дополнений много – их необходимо нумеровать. Пишут примечания в конце раздела или в конце самой ведомости, на не расчерченных листах. Во втором случае примечания обязательно нумеруются, вне зависимости от их количества. Кроме того, ведомость эксплуатационной документации дополняется перечнем папок, содержащих печатные документы, если таковые имеются. Папки перечисляются во всех графах по тому же принципу, что и документы – их наименование, местонахождение и количество, не указывается только обозначение. Разработка формуляра по ГОСТ Формуляр – документ, содержащий основные сведения о системе и отражающий её текущее состояние. Формуляр может разрабатываться как на всю систему в целом, так и на всё её отдельные компоненты. Треб ГОСТ 34.201-89 и РД 50-34.698-90 ГОСТ РД 50-34.698-90 так же предъявляет требования к содержанию формуляра: общие сведения; основные характеристики; комплектность; свидетельство о приемке; гарантийные обязательства; сведения о состоянии АС; сведения о рекламациях. Формуляр единственный документ, который ведётся на всём жизненном цикле системы. Чаще всего ответственным за ведение формуляра является ответственный за эксплуатацию системы (составной части автоматизированной системы). Большинство информации в формуляр заносится «от руки» на всём протяжении функционирования системы (АСУ). Описание программы и описание применения Данный документ относится к типу программно-эксплуатационной. Применяется к программе, комплексу, ПАК, программному компоненту или системе. Целевая аудитория: лица, которые принимают решение о покупке и вводе в эксплуатацию программы. Документ содержит информацию о функциональных возможностях программы и сфере её применения. Структуру и оформление документа определяется в ГОСТ 19.105-78 Информационная часть (аннотации и содержания) в соответствии с ГОСТ 19.502-78 7 Документ необходим для информирования потенциальных пользователей и покупателей о назначении программы и способах применения. Больше подходит для менеджеров (специалистов, системных администраторов), которые самостоятельно принимают решение о приобретении программы и вводе её в эксплуатацию. Всю необходимую информацию они смогут получить из этого документа: описание программы и ее применение. В описании программы и описании применения указываются: Задачи, которые решает программа; Затрачиваемые ресурсы для работы; Вводная информация; Выходные данные. Акцент делается на описательной части программы, её функциях и назначении. В меньшей степени на описании применения. Делается описание именно о возможностях программы и задач, которая она решает, а не её внутреннего устройства. При определённых особенностях программы допускается объединять разделы или вводить новые (дополнительные). Структура описания программы ( ГОСТ 19.402-78 ): 1. Общие сведения. 2. Функциональное назначение программы. 3. Описание логической структуры. 4. Технические средства, которые используются. 5. Вызов и загрузка. 6. Входные данные. 7. Выходные данные. Структура описания применения ( ГОСТ 19.502-78 ): 1. Назначение программы. 2. Условия применения. 3. Описательная часть задачи. 4. Входные и выходные данные. 5. Приложения (таблицы, иллюстрации и т.д.). Руководство системного программиста Руководство системного программиста относится к эксплуатационно-технической документации. Документ предоставляет сведения для проверки, обеспечения функционирования и конфигурирования программы, если данные возможности обусловлены системным кодом ПО. Во многих компаниях установка и глубокая настройка некоторых программ обычным пользователям запрещена. Данная работа входит в список обязанностей системного программиста, который проверяет логи, обеспечивает автоматическое резервное копирование данных, ведет статистику производительности и устраняет технические неполадки. Все перечисленные функции отображаются в документе «Руководство системного программиста». Данный документ разрабатывается и оформляется в соответствии с нормативами ГОСТ 19.503-79 , а также сопутствующими ГОСТ 19.101-77 (Виды программных документов) и ГОСТ 19.105-78 (Общие требования к программным документам). Руководство системного программиста должно включать всю необходимую информацию, чтобы разработчик имел возможность настраивать и поддерживать функциональность программного обеспечения (системы). Типовая структура документа приведена в ГОСТ 19.503-79 и включает: Общие сведения о программе - описывается назначение и функции программы. 1. Структура программы - составные части, компоненты, их связь и структура программы. 8 2. Настройка программы - отображаются необходимые действия по настройке программы в конкретных условиях применения, с использованием примеров. 3. Проверка программы – описываются способы проверки, которые устанавливают работоспособность программы; 4. Дополнительные возможности - описание дополнительного функционала и разделов программы. 5. Сообщения системному программисту - указываются тексты сообщений, которые выдаются во время проверки и настройки программы. 6. Приложения - иллюстрации, графики, таблицы и примеры. Содержание руководства Если руководство разрабатывается на простую монолитную программу, то документ получается относительно необъемным. Однако крупные аппаратно-программные комплексы требуют описания каждого компонента, чтобы обеспечить их интеграцию, а также работоспособность со сторонним ПО. В руководстве системного программиста излагают следующую информацию: сфера использования и задачи ПО; принципы действия; системные требования; описание процедуры установки компонентов; инструкция по настройке ПО; методы интеграции установленных программ с их копиями и сторонним ПО; периодичность и методика контроля работоспособности; методы и порядок обслуживания ПО; методы решения вспомогательных задач; работа в случаях аварийной ситуации. В зависимости от типа программы и способа ее настройки также может включаться другая информация (интерфейс, утилиты командной строки, язык для скриптов и т.д.). Разработка руководства программиста Руководство программиста относится к эксплуатационно-технической документации. Разрабатывается такой документ для программных продуктов. Предназначен для ознакомления программистом, который будет решать те или иные задачи, связанные с эксплуатацией данной программы. Руководство программиста необходимо в нескольких случаях: Программа, на которую составляется документация, представляет собой среду разработки или библиотеку. Данный программный продукт предоставляет платформу для написания типовых программ или систем. Распространение продукта проходит совместно с программным кодом или же происходит его постоянная модификация разработчиком. При помощи такого документа программисту должна быть представлена вся необходимая информация, которая может быть использована для создания собственных программных продуктов на базе данной системы. Информация должна быть предоставлена в достаточном количестве. Разработчики же при помощи руководства программиста имеют возможность зафиксировать текущее состояние выпускаемого продукта, чтобы избежать путаницы при выпуске новых продуктов. К типичным задачам такого документа относится: Уточнение и пояснение специалисту текущего состояния объектов, их местонахождения и методов взаимодействия. Также руководство программиста должно четко разграничить 9 объекты, которые изначально внесены в систему, и объекты, которые программист создает самостоятельно. Перечисление дополнительных средств разработки, которые потребуются при работе, кроме текущего продукта. Уточнение требований к системе, программной среды, а также средств, необходимых для запуска. Руководство программиста должно составляться грамотным профессионалом, знакомым со спецификой работы конкретного программного продукта и правилами составления подобных документов, регламентируемых по ГОСТ 19.504-79 Требования к заполнению руководств программиста установлены соответствующим государственным стандартом. Структура такого документа должна включать в себя: Предназначение и условия эксплуатации программного продукта. Основные характеристики программы. Методы обращения к программному продукту. Основная входная и выходная информация. Сообщения. Руководство оператора Руководство оператора ГОСТ чаще всего рассматривается как документ, в котором указаны конкретные действия оператора. Основная задача оператора – в режиме «on-line» осуществлять обслуживание системы или программного обеспечения входящего в систему, поэтому руководство оператора частично объединяет в себе информацию, предназначенную для пользователя и администратора системы (программы). Типовая структура руководства оператора регламентируется ГОСТ 19.505-79 и включает: Назначение программы Условия выполнения программы Выполнение программы Сообщения оператору В зависимости от особенностей допускается вводить новые разделы или объединять существующие. По своему изложению руководство оператора должно содержать минимально необходимую информацию, обеспечивающую нормальный режим работы оператора. В документе должно быть минимальное количество, а в идеале вообще не должно быть разделов содержащих теоретический материал не несущий никакой смысловой нагрузки. Описание языка Документ предоставляет пользователю языка возможности для решения задач, которые описываются на формальном языке. Фактически документ создан для системных программистов, операторов ЭВМ, кодеров, верстальщиков и тестировщиков. Стандарт для документа: ГОСТ 19.504-79 Формальные языки включают в себя возможные языки программирования, разметки и описания структур, языки управления заданиями, языки описания экранных и печатных форм и т.д. Сами языки могу значительно отличаться друг от друга, но, при этом, все состоят из определенного набора элементов и подчиняются грамматическим правилам. Основная задача описания предоставить пользователю полную информацию по формальному языку и дать возможность применять этот язык по своему усмотрению. Описание языка включает следующие пункты: Назначение языка и его сфера применения. Конечный результат, написанный на языке (программы, макросы и т.п.) 10 Синтаксические правила языка. Возможные элементы текста и варианты их взаимодействия. Логика работы программы или обработки документа. Процесс может кординально отличаться. Например, процессы компиляция и интерпретация программного кода. Составные элементы языка и синтаксических конструкций. В основном это операторы, теги, ключи и т.д. Встроенные функции (стандартные возможности). Описание языка может содержать: указания по применяемому стилю программирования; виды ошибок, алгоритм их поиска и устранения; рекомендации для оптимизации быстродействия или памяти; список рекомендуемых трансляторов (фреймворков или парсеров). И иные моменты взаимодействия с языком, которые помогут пользователю в работе с ним. Основная задача документа - донести до конечного пользователя основную идею языка. Сам текст должен быть понятным как для продвинутого программиста, так и для начинающего пользователя. Важно не углубляться в описание технологии программирования и не описывать подробно все базовые элементы (цикл, функции, константы и т.п.). Примеры допустимы, но только для того, чтобы показать синтаксис. Согласно ГОСТ 19.506-79 структура описания языка программирования должна быть следующей: Общие сведения. Элементы языка. Методы структурирования программы. Средства обмена данными. Встроенные элементы. Средства отладки. Руководство по техническому обслуживанию Руководство по техническому обслуживанию относится к эксплуатационной документации, которое содержит описание функций, общие указания к применению и обслуживанию программы. Главная задача документа — обеспечение персонала информацией о правильном применении и техническом обслуживании программы. Руководство по техническому обслуживанию разрабатывается для пользователей программы, а также специалистов, которые занимаются обслуживанием программного обеспечения. В документе отображаются сведения для использования диагностических, тестовых и других типов программ, которые применяются при техническом обслуживании. Документ разрабатывается в соответствии со стандартами ГОСТ 19.105-78 (общие требования к программным документам) и ГОСТ 19.508-79 (требования к оформлению руководства по техническому обслуживанию). Руководство по техническому обслуживанию является частью общей документации на программное обеспечение и сопутствующее оборудование, а также входит в состав руководства по эксплуатации. Обязательные разделы руководства по техническому обслуживанию: 1. Аннотация. - Характеристика документа, краткое описание его назначения, содержания, вида и прочих особенностей. 2. Содержание - Указываются заголовки документа с соответствующими номерами страниц. 3. Введение - Определяется цель руководства, перечень эксплуатационной документации и общие сведения (п. 2.1 ГОСТ 19.508-79 ). 4. Общие указания - В разделе отображаются указания по организации, порядок и методика проведения технического обслуживания (п. 2.2 ГОСТ 19.508-79 ). 11 5. Требования к техническим средствам - Определяется полный состав технических средств, которые необходимы для работы (п. 2.3 ГОСТ 19.508-79 ) 6. Описание функций (п. 2.4 ГОСТ 19.508-79 ) : Максимальный список тех. средств; Описание функционирования оборудования и технических средств, а также определение способа обработки ошибок; Входные и выходные данные, которые применяются при техническом обслуживании; Определяются возможные результаты работы и возможность взаимодействия оборудования с другими средствами. В зависимости от типа оборудования могут вводиться дополнительные разделы: хранение, транспортировка, способы утилизации и т.д. Использование рисунков, схем и фотографий допускается в рамках требований соответствующих нормативов. Даже если интерфейс администратора интуитивно понятен, однако руководство по техническому обслуживанию остается обязательным документом. В особенности это касается программ и оборудования, которое обслуживается несколькими людьми. Для каждой группы следует прописывать уровень доступа, выполняемые функции, требования к обслуживанию и т.д. |