http://blog.csdn.net/luyanc/article/details/53886028?foxhandler=RssReadRenderProcessHandler
Там будет много документов на этапе разработки программного обеспечения, включая руководство по эксплуатации и руководство пользователя, то в чем разница между этими двумя документами?
Сначала посмотри на две картинки:
Очевидно, что руководство по эксплуатации и руководству пользователя должны быть доставлены пользователю, но два написанные документы отличаются, поэтому уровень пользователей, который использует два документа, также отличается. Просто руководство по эксплуатации — это документ на уровне системы, рассказывая, как управлять, управлять системой. Руководство пользователя — это документ на уровне спроса, который направляет пользователя для управления системой для завершения нужных функций. Если пользователь делится на два уровня администраторов и пользователей общего пользователей, это руководство пользователя для пользователя для доставки администратора.
Вид документации
Друзья! Мы перешли с форума в Телеграм. Давайте быстрее к нам!
@twriters 
чат для технических писателей в Telegram
чат для технических писателей в Telegram Зарегистрируйтесь
|
Ovin Не определившийся Сообщений: 6 |
#1 Мне нравится0 25.08.2015 12:22:45 Здравствуйте. Из прочитанного пришла к выводу, что техническая документация разделяется на:
Или гуру профессии, поправьте меня! Акт о результатах опытной эксплуатации ППО; |
|
H&M User
Эксперт Сообщений: 312 |
#2 Мне нравится0 26.08.2015 16:48:17 По ГОСТ 34.201 документация:
Отдельно существует также технологическая (ЕСТД, ГОСТ 3.1102-2011). Конструкторская документация:
Отдельно в конструкторской документации по способу выполнения выделяют:
Так…. понял… Тут можно еще долго расписывать, поэтому про программные и технологические документы не буду — хватит ссылок на ГОСТы. А чтобы не путаться, следует принять несколько простых правил:
Любой проектный документ может быть эксплуатационным, технологическим или программным. Все зависит от того, согласно какого ГОСТ, ГОСТ Р или РД выполняется. Согласно всего вышесказанного Ваш список может принять следующий вид: Акт о результатах опытной эксплуатации ППО; ОР+Э где: P.S.: Примеры расшифровки: P.P.S.: Данное представление классификации считать сугубо личным мнением автора. Изменено: H&M User — 26.08.2015 17:18:21 |
|
Виктор Фигурнов Эксперт Сообщений: 303 |
#3 Мне нравится0 31.08.2015 14:29:10
Иногда выделяются и другие виды документации. Например, по рекомендациям Р 50-605-80-93 техническая документация на военную технику подразделяется на нормативно-техническую, конструкторскую, технологическую и программную. По моему мнению, все классификации ГОСТов сильно устарели, как и приведенный Вами список документов. В настоящее время международными стандартами ISO техническая документация классифицируется по виду (описание, план, политика, процедура, отчет, запрос, спецификация), и по процессу жизненного цикла системы или услуги, к которому относится документ. См., например, стандарты:
Стандартом ISO/IEC/IEEE 15289:2015 «Содержание информационных продуктов процесса жизненного цикла систем и программного обеспечения (документация)» предусмотрены следующие виды документации: Спецификация
Описание
Отчет
План
Политика
Процедура
Запрос
Там же описано соответствие этих видов документации и видов процессов жизненного цикла систем, программного обеспечения и сервисов. Изменено: Виктор Фигурнов — 31.08.2015 16:50:22 |
||
|
H&M User
Эксперт Сообщений: 312 |
#4 Мне нравится1 31.08.2015 17:38:59 Виктор, скажите, у Вас уже есть GOST R ISO 15289-20ХХ или это просто вольный перевод видов документации из ISO/IEC/IEEE 15289:2015? |
|
Виктор Фигурнов Эксперт Сообщений: 303 |
#5 Мне нравится1 31.08.2015 18:20:56
Такого ГОСТ нет, но юридический статус стандартов ISO и ГОСТ в Российской Федерации одинаков. Согласно закону РФ «О техническом регулировании», стандарты — это документы, в которых в целях добровольного многократного использования устанавливаются характеристики продукции, правила осуществления и характеристики процессов проектирования (включая изыскания), производства, строительства, монтажа, наладки, эксплуатации, хранения, перевозки, реализации и утилизации, выполнения работ или оказания услуг (ст. 2 Закона). К документам в области стандартизации, используемым на территории Российской Федерации, относятся как национальные стандарты, так и международные стандарты (ст. 13 Закона). Так что Вы, ваше начальство или ваш заказчик можете добровольно принять решение о соблюдении, полностью или частично, как ГОСТ, так и стандарта ISO или иного международного стандарта.
Полагаю, что договор можно считать спецификацией прав и обязанностей сторон по поводу предмета договора.
Русский язык, как и другие естественные языки, не отличается однозначностью. Многие слова имеют несколько значений. В словарях я нашел 6 разных значений слова «спецификация». Например: спецификация — не обусловленная договором переработка материала, в результате которого создается новая, иного рода вещь (не обусловленное договором изготовление стола из дерева и т.п.).; спецификация — перечисление подробностей, на которые необходимо обратить особое внимание… По тем же стандартам ГОСТ 19 пользователь — это организация-держатель дубликата. Изменено: Виктор Фигурнов — 31.08.2015 18:58:55 |
||||||
И что из этого?|
H&M User
Эксперт Сообщений: 312 |
#6 Мне нравится0 01.09.2015 17:48:11
Ничего, зато из этого становится логически понятно, что организация-держатель оригинала — это разработчик или правообладатель |
||
|
Vita Не определившийся Сообщений: 31 |
#7 Мне нравится0 26.05.2017 11:54:37 Добрый день! Готовясь к аттестации столкнулась с вопросом «Разница между руководством пользователя и руководством по эксплуатации?». Подскажите в чем разница? |
|
#8 Мне нравится0 31.05.2017 16:18:49 Как правило, Руководство пользователя идет к программному продукту, а Руководство по эксплуатации, на прибор, например, на телевизор или стиральную машину |
|
|
Виктор Фигурнов Эксперт Сообщений: 303 |
#9 Мне нравится0 01.06.2017 18:20:57 Вполне могут быть (и бывают) Руководство пользователя автомобиля и Руководство по эксплуатации программы. То есть не всегда Руководство пользователя относится к ПО, а Руководство по эксплуатации к изделиям. Отличие в процессах, которые описываются в этих руководствах. И а аудитории. Для многих объектов пользование и эксплуатация это совершенно разные процессы. Например: Руководство пользователя поиска Яндекса это может быть несколько страничек для конечного пользователя со сведениями, как составлять запросы на поиск, просматривать и уточнять результаты поиска. Руководство по эксплуатации поиска Яндекса может многотомным талмудом для команды эксплуатации поиска с описанием, какие компоненты и программные средства реализуют поиск, как их надо устанавливать, настраивать, сопрягать друг с другом, проверять, запускать в эксплуатацию, производить восстановление при сбоях, осуществлять мониторинг корректности функционирования, тестировать производительность, анализировать качество поиска и т.д., и т.п. Если ваше начальство или заказчики являются гостофилами, вас не убудет если Руководство пользователя или Руководство по эксплуатации сделаете с учетом требований подходящих ГОСТов. Например, Руководство по эксплуатации изделия машиностроения или приборостроения — с учетом ГОСТ 2.610-2006 «Правила выполнения эксплуатационных документов». |
|
Виктор Фигурнов Эксперт Сообщений: 303 |
#10 Мне нравится1 01.06.2017 18:25:58
Теперь появился такой ГОСТ: ГОСТ Р 56713-2015 (ISO/IEC/IEEE 15289:2011) «Системная и программная инженерия. Содержание информационных продуктов процесса жизненного цикла систем и программного обеспечения (документация)» Утвержден и введен в действие Приказом Федерального агентства по техническому регулированию и метрологии от 16 ноября 2015 г. № 1820-ст |
||
|
writer
Администратор Сообщений: 1890 |
#11 Мне нравится0 01.06.2017 19:10:28 Виктор спасибо! Добавлю на сайт в ближайшее время. |
- Понятие руководства по эксплуатации
Руководство по эксплуатации, которое также иногда называют инструкцией по эксплуатации, представляет собой документ, в котором исчерпывающим образом описывается корректный процесс использования продукта, будь то сложный производственный механизм или электронная игра. Поэтому с необходимостью разработки такого руководства сталкиваются компании самого различного профиля.
Навигация по странице:
- Понятие руководства по эксплуатации
- Статус руководства по эксплуатации в ряду прочих технических документов
- Области применения руководства по эксплуатации
- Дополнительные сферы применения РЭ
Понятие руководства по эксплуатации
Содержание термина «руководство по эксплуатации» принято трактовать в соответствии с положениями ГОСТ 2.601-2006 «Единая система конструкторской документации (ЕСКД). Эксплуатационные документы». Указанный национальный стандарт определяет данное руководство как важный документ, в котором содержится исчерпывающая информация о характеристиках продукта, его конструкции и принципах работы, правилах безопасной эксплуатации и осуществления работ с применением данного изделий.
Кроме того, в руководстве по эксплуатации принято указывать порядок осуществления оценки технического состояния изделия в разрезе необходимости проведения профилактических, ремонтных или утилизационных работ в отношении всего продукта или отдельных его деталей и частей.
Статус руководства по эксплуатации в ряду прочих технических документов
ГОСТ 2.601-2006 относит руководство по эксплуатации к разряду эксплуатационных документов наряду с инструкцией по монтажу, паспортом изделия, ведомостью наличия прилагаемых запчастей и проч. Таким образом, на данное руководство распространяются соответствующие правила Единой системы конструкторской документации (ЕСКД). В частности, это относится к положениям ГОСТ 2.610-2006 «Единая система конструкторской документации. Правила выполнения эксплуатационных документов».
Требования ГОСТ 2.601-2006 устанавливают, что разработка руководства по эксплуатации не носит обязательного характера в отношении всех без исключения видов изделий: необходимость формирования этого документа определяется самим создателем продукции с учетом сложности его использования, необходимости применения дополнительной информации для корректной настройки и применения и других факторов. При этом в данном нормативно-правовом документе имеется оговорка о том, что в случае, если разработка конкретного продукта производится по заказу Министерства обороны РФ, именно это ведомство будет выступать в качестве органа, принимающего решение о необходимости разработки руководства по эксплуатации (РЭ).
Для этих случаев и содержание, и форма руководства по эксплуатации должны соответствовать самым последним требованиям государственных стандартов и иных действующих нормативных документов. Чтобы обеспечить уверенность в том, что созданная документация отвечает всем этим условиям, а вместе с тем понятна потребителям и обеспечивает им удобство и безопасность при работе с изделием, целесообразно обратиться в специализированную организацию, которая имеет большой опыт создания таких документов.
Вместе с тем, при решении вопроса о необходимости создания РЭ для конкретного вида продукции разработчику необходимо учитывать, что такой документ позволяет пользователям изделий быть уверенными в правильности порядка его эксплуатации и обеспечивает безопасность персонала, работающего с тем или иным изделием. Поэтому при выпуске специального оборудования, предназначенного для использования в процессе работ на опасных производственных объектах, предоставление заказчикам РЭ является обязательным.
Кроме того, оно может потребоваться для получения ряда разрешительных документов:
- например, РЭ необходимо для получения специального разрешения Ростехнадзора на использование особо сложного и опасного оборудования в случаях, когда получение такого разрешения является необходимым условием для осуществления соответствующих работ;
- также этот документ, как правило, запрашивают исполнители в случае проведения процедуры сертификации для данного вида продукции.
Таким образом, разработка РЭ – это ответственная процедура, к которой компании-производителю необходимо подойти с должной серьезностью.
Документ, в котором прописаны пошаговые действия пользователя по сборке и использованию того или иного устройства, может иметь разные названия: паспорт по эксплуатации, руководство по эксплуатации, руководство по монтажу, инструкция по применению и так далее. Но формально правильнее называть документ руководство по эксплуатации или паспорт по эксплуатации. Часто также применяется аббревиатура РЭ.
Руководство по эксплуатации входит в состав технико-эксплуатационной документации изделия. Туда также входят такие документы, как технический паспорт, каталог деталей, формуляры и многое другое.
Основная цель паспорта или руководства по эксплуатации – ознакомить пользователя с принципами работы технического устройства или оборудования, его монтажом, обслуживанием и ремонтом.
Содержание руководства по эксплуатации
Руководство или паспорт по эксплуатации разрабатывается, принимая за основу ГОСТ 2.601-2019, в котором описаны принципы разработки разной эксплуатационной документации технического оборудования.
Обычно руководство по эксплуатации состоит из следующих основных разделов:
- Описание технического устройства и функции;
- Назначение и эксплуатация;
- Обслуживание устройства;
- Ремонт устройства;
- Правила хранения, перевозки и утилизации.
Это далеко не полный перечень разделов содержания руководства по эксплуатации. Паспорт может быть дополнен любыми необходимыми разделами, так как стиль оформления документа вполне свободный.
В руководстве по эксплуатации, согласно ГОСТу, следует применять глаголы в повелительном наклонении, например, «нажать», «включить», «взять», «повернуть» и т.п. Также нельзя забывать о логике действий пользователя. То есть, каждое действие, выполнить которое призывает документ, должно исходить из логики предыдущего.
При оформлении руководства по эксплуатации на особо сложное или опасное оборудование, следует особое внимание обратить на правила безопасности. В нужных точках всегда нужно приписывать такие предостерегающие слова, как «Осторожно!», «Внимание» и т.п. А для оборудования повышенной опасности на титульном листе руководства по эксплуатации нужно обязательно прописывать предостерегающую надпись.
Также важно приводить разного рода схемы, чертежи и рисунки, которые помогут пользователю лучше воспринимать текст документа.
Что касается технического оформления руководства по эксплуатации, информация об этом также прописана в ГОСТе 2.601-2019. В нём можно найти такие детали, как носитель документа, формат и качество бумаги, шрифт и размер, и многое другое.
Для быстрого и качественного выполнения разработки руководства или паспорта эксплуатации рекомендуем обратиться в наш центр. За плечами наших сотрудников десятки лет разработки технической документации – технических условий, обоснований безопасности, паспортов безопасности и много другого.
Разработка технической документации
Разработаем паспорт на изделие, руководство по эксплуатации, габаритные чертежи, инструкцию по сборке.
Разрабатываем техническую документацию на изделие:
- паспорт изделия;
- руководство по эксплуатации;
- сборочные схемы;
- габаритные чертежи.
Техническая документация — составная часть конструкторской документации, выполняемой по ЕСКД и в полном объеме.
Технические документы на изделие понадобятся в следующих случаях:
1. В случае разработки и изготовления нового изделия. Техдокументация в комплекте с чертежами на выпускаемое изделие передается заказчику.
2. В случае сертификации изделия. Техдокументация передается в сертифицирующий орган для экспертизы и выдачи заключения.
3. В случае ввоза изделия из зарубежа и его растамаживания.
4. В случае, если изделие представляет собой комплекс из составных покупных изделий, но поставляется как новое изделие заказчику на территории России. В этом случае требуются подтверждающие документы, что изделие было произведено (или собрано) на территории РФ. Такими документами и служит паспорт на изделие, включающий в себя габаритные чертежи.
Руководство по эксплуатации (РЭ)
РЭ включает в себя сведения о конструкции, принципе работы, свойствах технического изделия и его составных частей, а также правила безопасной эксплуатации. Состав РЭ закреплен в ГОСТ 2.601-2006. Единая система конструкторской документации. Эксплуатационные документы.
Обязательные разделы РЭ:
- Введение
- Описание и работа.
- Использование по назначению.
- Техническое обслуживание.
- Текущий ремонт.
- Хранение.
- Транспортирование.
- Утилизация.
Паспорт на изделие
Паспорт — обязательный в комплекте КД документ, удостоверяющий технические параметры и характеристики изделия, которые гарантирует изготовитель, а также сведения о сертификации и утилизации изделия.
Паспорт на техническое устройство разрабатывается согласно ГОСТ 2.610-2006 и содержит следующие обязательные разделы:
- Техустройство и технические данные.
- Комплектность.
- Ресурсы, сроки службы и хранения и гарантийные обязательства.
- Консервация.
- Свидетельство об упаковывании.
- Свидетельство о приемке.
- Утилизация.
- Особые отметки.
- Сведения о цене и условиях приобретения техустройства.
Чем отличается паспорт и руководство по эксплуатации
В паспорте содержаться основные (краткие) технические сведения об устройства, комплектность. В отличие от РЭ есть разделы гарантий, сведений о упаковке и приемке.
В РЭ дополнительно и более широко излагается принцип работы, конструкции, монтажа и эксплуатации изделия, приводится больше подробных технических схем.
Но очень во многом эти два документа дублируют друг друга, поэтому ГОСТом допускается совмещать паспорт и руководство по эксплуатации в одном документе. При этом на титульном листе так и пишут: «Паспорт и руководство по эксплуатации».