Стандартизация в оформлении технической документации

В этой статье:

Нормативно-техническая документация

Стандартизация в оформлении технической документации

Нормативно-техническая документация – совокупность материалов и документов, обеспечивающих качество производимой продукции, а также ее соответствие всем утвержденным требованиям безопасности, условиям эксплуатации, хранения и транспортировки. Одним словом нормативно-техническая документация – это своего рода стандарт предприятия, в соответствии с которым осуществляется весь производственный процесс.

В наше время разработка нормативно-технической документации на производство позволяет предприятиям оптимизировать осуществляемые работы и привести их в соответствии со всеми требованиями законодательства Российской Федерации.

Нормативно-техническая документация – это полный комплект документов, позволяющий без лишних финансовых потерь и затрат дополнительных ресурсов, производить качественную и безопасную продукцию, соответствующую всем нормативам и государственным стандартам.

К нормативно-технической документации относятся следующие виды документов:

  • технические условия (ТУ);
  • технологическая инструкция (ТИ);
  • технологический регламент (ТР);
  • технологический процесс (ТП);
  • паспорт безопасности (ПБ);
  • этикетка;
  • рецептура;
  • паспорт качества.
Рекомендуем!  Требования к оформлению документов по личному составу

Технические условия

Технические условия – документ, разрабатываемый предприятием для производства какого-либо вида продукции в том случае, если для данной продукции законодательством Российской федерации еще не установлены обязательные требования по изготовлению, или требуется дополнить соответствующий ГОСТ, применяемый к данной категории товаров.

Технические условия являются неотъемлемой частью конструкторской документации и разрабатываются в соответствии с установленными стандартами, указанными в ГОСТ 2.

114-95 «Единая система конструкторской документации», и ГОСТ Р 51740 «Пищевые продукты – общие требования к разработке и оформлению»,  и содержат в себе следующую информацию:

  • технологические требования;
  • требования по безопасности;
  • правила приемки;
  • требования по обеспечению охраны окружающей среды;
  • указания по эксплуатации;
  • условия хранения и транспортировки;
  • требования по маркировке;
  • методы контроля и гарантии изготовителя.

Следует учитывать, что технические условия должны быть разработаны, утверждены и зарегистрированы в установленном законодательством порядке, только в этом случае, данный нормативно-технический документ может являться основанием для начала производственного процесса.

Технологическая инструкция

Технологической инструкцией называется вид нормативно-технической производственной документации, разрабатываемой предприятием для производства какой-либо продукции.

Содержит в себе информацию о технологических процессах производства и о выпуске товаров непосредственно на потребительский рынок страны.

Разработка данного документа осуществляется для одного конкретного вида изделий или группы идентичных изделий в соответствии с требованиями ГОСТ № 34, определяющего основные этапы по разработке и конечному результату изготовленной продукции.

Технологический регламент

Технологический регламент – документ, устанавливающий основные методы производства технические условия и средства, а также технологические нормативы и порядок осуществления производственного процесса на предприятии. В зависимости от производства выделяют три основных вида технологических регламентов:

  • постоянный – разрабатываемый для проработанного производственного процесса;
  • временный – необходим для производства нового вида продукции, или в том случае, если предприятием вносятся какие-либо корректировки в установленный производственный процесс;
  • разовый – разрабатывается для продукции, которая производится единичной партией или для проведения научно-исследовательской работы.

Технологический процесс

Технологический процесс – совокупность мероприятий, обеспечивающих последовательность производства продукции с момента начала изготовления до получения конечного результата.

Технологический процесс разрабатывается с целью оптимизации работы на предприятии, что непосредственным образом влияет на качество продукции и ресурсы, необходимые для обеспечения производственного процесса.

Разработка предприятием технологического процесса позволяет с высокой точностью определить не только количество необходимого оборудования, инструментов и приспособлений для производства изделий, но и число рабочих и обслуживающего персонала для выполнения данного процесса.

Паспорт безопасности

Паспорт безопасности – документ, подтверждающий безопасность продукции при ее эксплуатации, хранении и транспортировке, является частью нормативно-технической документации, необходимой для реализации отдельных видов продукции. Данный документ разрабатывается в том случае если:

  • предприятие производит те или иные вещества, которые способны нанести вред здоровью или жизни человека;
  • предприятием изготавливается продукция, степень опасности которой еще не установлена;
  • если на предприятии производится продукция, признанная опасной по международным нормам;
  • компания производит продукцию, к которой установлены особые требования и нормы.

Этикетка

Этикетка – графический или текстовый знак, представляющий собой наклейку, бирку или талон определенного вида продукции, в которой содержится вся необходимая для идентификации продукции информация.

Этикетка должна быть изготовлена в соответствии со всеми правилами и нормативами, регламентирующими разработку нормативно-технической документации предприятия.

В соответствии с данными законодательными актами, этикетка должна содержать в себе следующую информацию:

  • данные о продукте на русском языке;
  • состав продукта;
  • пищевая ценность;
  • наименование изготовителя;
  • страна происхождения;
  • товарный знак изготовителя;
  • масса нетто или количество продукта;
  • условия хранения и транспортировки;
  • срок годности;
  • обозначение технического документа, на основании которого была произведена продукция (ТУ или ГОСТ);
  • информация о сертификации продукции;
  • другая информация о содержании каких-либо дополнительных компонентов, обязательных для указания на этикетке.

Рецептура

Рецептура – основная часть технологической документации, разрабатываемая предприятием на многокомпонентные (два или более) виды продукции, устанавливающая перечень и количественное содержание применяемых при производстве изделий сырья, материалов и полуфабрикатов.

Разработка рецептуры может осуществляться как на основании уже действующих рецептур и правил, так и на основе новых продуктов и технологий. Основными данными рецептуры изделия являются:

  • требования по качеству сырья, используемого при производстве;
  • нормы расхода сырья при изготовлении одной единицы продукции;
  • предельные нормы потерь;
  • пределы допустимых отклонений в массе готовой продукции;
  • характеристики физико-химических и органолептических показателей и других свойств продукции;
  • сроки хранения и годности продукции.

Паспорт качества

Паспорт качества – документ, необходимый для многих категорий непродовольственных товаров, содержащий описание всех его свойств и характеристик. В зависимости от вида и категории изделия паспорт качества может содержать в себе следующую информацию:

  • полная информация о компании-изготовителе продукции;
  • регистрационный номер документа и дата его выдачи;
  • полное наименование товара, включая его марку;
  • все свойства и характеристики изделия;
  • дата изготовления продукции;
  • номер партии (если изделия производятся партиями);
  • количество продукции каждой марки;класс опасности;
  • другая необходимая информация.

Следует учитывать, что при разработке различного рода нормативно-технической документации для предприятий Барнаула необходимо хорошо знать и разбираться в аспектах производственного процесса и законодательных документах, в соответствии с которыми определяется данный процесс изготовления.

Именно поэтому, в данном случае, идеальным решением станет обращение в соответствующий специализированный центр, специалисты которого имеют огромный опыт в разработке, утверждении и регистрации соответствующих нормативно-технических документов, позволяющих с высоким качеством и без потерь наладить производственный процесс, обеспечивающий непрерывность и безопасность изготовления продукции.

Центр сертификации «Ростест Барнаул» обеспечит профессиональный подход к разработке необходимой документации в соответствии со всеми требованиями законодательства Российской Федерации.

Источник: http://rostestbarnaul.ru/normativno-texnicheskaya-dokumentaciya/

Оформление технических документов

Стандартизация в оформлении технической документации

Технические документы — комплекс документации технического характера, в которых содержится различная информация о деталях, принципах, а также методах производственного процесса, характеристики изготовляемой продукции, принципы и правила использования данной продукции, и другая важная информация о конкретном предприятии (организации).

Что такое оформление технических документов

Под понятием «оформление технических документов» подразумевают оформление следующих документов:

— технические условия;

— аттестация рабочих мест;

— поверка и калибровка;

— разработка СТО;

— разработка рецептур;

— технологический регламент;

— каталожный лист;

— руководство по эксплуатации;

— удостоверение повышения квалификации;

— технологическая инструкция.

Оформление технических документов в РФ проводится согласно определенным правилам.

Первое и главное правило оформления состоит в том, что получить технические документы — не вопрос выбора руководителя конкретного предприятия, но исполнение требования государства.

Согласно Федеральному Закону РФ и другим нормативным документам, оформление технических документов проводится на обязательном условии. Поэтому, нежелание получить технические документы приводит к соответствующей ответственности.

Каким правилам подчиняется оформление технических документов

Технические документы оформляются в территориальных центрах сертификации. Перед тем, как обратиться в определенный центр сертификации необходимо уточнить, имеет ли данный центр соответственное разрешение на оформление технических документов.

Некоторые технические документы руководитель организации может оформить самостоятельно, но в такой ситуации очень важно понимать, что человек, не знающий актуальных правил сертификации, просто не в состоянии оформить технический документ безошибочно. Поэтому, советуем вам не тратить драгоценные дни на изучение нормативной документации, а сразу же обращаться услугам квалифицированных сотрудников центров сертификации.

Получить технические документы можно лишь по прохождению всего процесса оформления.

«Купить технические документы» — невозможно, ведь помимо анализа документации о компании, необходимо пройти другие этапы проверок (анализ условий рабочего места на предприятии, анализ качества изготавливаемого продукта прочее).

Каждая компания, которая решает получить технические документы, и которая позиционирует себя как ответственная и честная, проходит все этапы разработки технической документации.

Оформление технических документов проводится согласно следующему алгоритму:

— обращение в выбранный центр сертификации;

— предоставление нужной документации о компании, которая желает получить технические документы;

— предоставления полной документации о продукции (технологии, устройстве прочее), на которую оформляются технические документы;

— этап проверки предприятия или продукции на качество, безопасность, соблюдение норм и государственных требований;

— этап регистрации или утверждения руководителем предприятия уже оформленного технического документа;

— вручение оформленного технического документа уполномоченному лицу компании, инициирующей процесс оформление технических документов.

Вышеприведенный алгоритм получения технической документации, конечно, может разниться в зависимости от вида оформляемого документа и от продукции, на которую он оформляется. Но все же, большинство технических документов оформляются согласно такой схеме.

Что является основанием оформления технических документов

Полный список нужных документов (для того чтоб получить технические документы) составляются в процессе консультации с сотрудником центра сертификации. Как правило, документы, которые представляются сотруднику центра сертификации, содержат следующую информацию:

— полная документация об организации (предприятии, компании), на имя которой оформляются технические документы;

— полная документация о соблюдении требований (российских и международных) о процессе и технологиях изготовления продукции, о помещении (в котором проводится изготовление продукции, а также ее хранение) прочее;

— оформленные сертификаты и другие документы, которые подтверждают, что  безопасность и качество продукции являются высокого уровня и соответствуют предъявляемым требованиям;

— полная документация о продукции или изготовляемом товаре (как описательная, так и техническая документация).

Все технические документы должны соответствовать определенным требованиям:

— технические документы, которые были оформлены на конкретный продукт и сопровождают этот продукт при его реализации, обязательно должны соответствовать этому продукту.  Например, руководство по эксплуатации, оформленное на домашний холодильник, должно содержать полную информацию по использованию холодильника именно этой конкретной модели;

— оформление технических документов должно проводиться согласно определенным требованиям и вся информация, которая представленная в конкретном техническом документе обязательно должна соответствовать требованиям и нормам (прописанным в нормативных документах РФ);

— в ситуации, когда оформление технических документов предусматривает их утверждение руководством организации, важно помнить, что без проведения данной процедуры документация не может считаться действительной.

Ответственность за оформление технических документов

Ответственность за правдивость и соблюдение прописанной информации в технических документах возлагается на руководство организации, на имя которой было проведено оформление технических документов. Кроме того, руководство предприятия, после получения технического документа, обязано информировать сотрудников данного предприятия обо всех изменениях в процедуре или технологии производства, вступивших в силу после оформления технической документации.

Руководители предприятий также обязаны внедрить все принципы, прописанные в технических документах и привести процедуру изготовления продукции в соответствие установленным требованиям.

Каждый оформленный технический документ имеет определенный срок действия, окончанию которого необходимо либо продлить срок действия данного документа, либо пройти процедуру его оформления повторно.

Важно понимать, что действие каждого технического документа может быть остановлено, если на предприятии найдено нарушение принципов технического документа или же после вступления в действие Федерального Закона, который изменил основные нормы, согласно которым было проведено оформление технических документов.

Конечно, невозможно описать в одной статье все условия и требования к процессу оформления технической документации. Главное, что нужно запомнить, что технические документы — невероятно важная документация, которая должна оформляться только профессионалами. Каждая компания, которая хочет получить технические документы, должна обращаться в центр сертификации.

Наш сертификационный центр «Форатест» окажет все услуги для того, чтоб получить технические документы для вас стало незначительным моментом, а не поводом для нервов и паники. Обращайтесь для получения консультационных услуг или с желанием полностью доверить оформление технических документов нашим сотрудникам — мы будем рады сотрудничеству с вами!

Источник: http://foratest.ru/main/oformleniye-texnicheskix-dokumentov/

Унификация и стандартизация документов 2

Стандартизация в оформлении технической документации

Введение…………………………………………………………………………………………………6

Унификация и стандартизация документов…………………………………………….8

Унифицированные системы документации……………………………………………12

Общероссийские классификаторы технико-экономической и социальной информации………………………………………………………………………………18

Заключение ………………………………………………………………………………25

Список литературы………………………………………………………………………26

Введение

Унификация документов заключается в установлении единообразия состава и форм управленческих документов, фиксирующих осуществление однотипных управленческих функций. Стандартизация документов — это форма юридического закрепления проведенной унификации и уровня ее обязательности.

Установлены следующие категории стандартов: государственные стандарты (ГОСТ), отраслевые стандарты (ОСТ), республиканские стандарты (РСТ).

Унификация документов проводится в целях сокращения количества применяемых документов, типизации их форм, повышение качества, снижения трудоемкости их обработки, дотсяжения информационной совместимости различных систем документации по одноименным и смежным функциям управления, более эффективного использования вычислительной техники.

Работа по унификации включает:

· Разработку унифицированной системы документоведения (УСД), которая осуществляется министерствами и ведомствами, ответственными за соответствующие системы документации;

· Внедрение межотраслевых (межведомственных) УСД в рамках республиканских и отраслевых УСД;

· Ведение УСД и Отраслевого классификатора технико-экономической документации (ОКТЭИ) с целью поддержания достоверности информации и ее дальнейшего развития;

· Разработку комплексов отраслевых унифицироованнвых форм документов, отражающих специфику отрасли и не вошедших в УСД, а также их государственную регистрацию;

· Разработку отраслевых классификаторов технико-экономической информации, отражающих специфику отрасли. Организационное и методическое руководство унификацией и стандартизацией документов, координацию соответствующих работ и контроль осуществляет головная организация по координации внедрения и ведения УСД и ОКТЭИ в республике. На отраслевом уровне эту работу проводит головная организация по внедрению и ведению УСД и ОКТЭИ в отрасли.

Значение унификации документов возрастает в связи со все более широким внедрением в практику управления электронно-вычислительной техники и созданных на ее основе автоматизированных систем управления.

Разработанная ВНИИДАД унифицированная система организационно-распорядительной документации пригодна как для использования в автоматизированных системах управления, так и при обработке обычными, традиционными методами в учреждениях страны.

В УСОРД входят комплекс государственных стандартов на организационно-распорядительную документацию, унифицированные формы документов, а также инструктивно-методические материалы по применению этих форм.

Унификация и стандартизация документов

Технический прогресс обуславливает новые требования к составлению официальной документации.

Система ДОУ включает три взаимосвязанных составных частей: подготовка управленческих документов, технология работы с документами, систематизация документов в течение календарного года и организация их архивного хранения.

При решении каждой из названных проблем специалисты-практики должны руководствоваться действующими нормативно-методическими документами в области делопроизводства, утвержденными Государственным комитетом РФ по стандартизации и Федеральной архивной службой России.

Нормативно-методическая база делопроизводства — это совокупность законов, нормативных правовых актов и методических документов, которые регламентируют технологию создания, обработки, хранения и использования документов в текущей деятельности учреждения и работу службы делопроизводства.

Основные требования к оформлению организационно-распорядительных документов изложены в ГОСТ Р. 6.30-97, утвержденном Постановлением Госстандарта России от 31 июля 1997 года.

Огромное количество документов вызывает необходимость их стандартизации и унификации.

Стандартизация — это деятельность по установлению норм, правил.

Стандартизация — это процесс установления и применения правил с целью упорядочения деятельности в данной области на пользу и при участии всех заинтересованных сторон, в частности для достижения всеобщей оптимальной экономии с соблюдением функциональных условий и требований безопасности. Стандартизация основывается на результате науки, техники и практического опыта.

В области делопроизводства суть стандартизации заключается в возведении в норму, обязательную для применения, оптимальных правил и требований по разработке и оформлению документов, принятых в установленном порядке для всеобщего и многократного и применения.

Стандартизация, в соответствии с законом Российской Федерации «О стандартизации», принятым 10 июня 1993 г., — это деятельность по установлению норм, правил и характеристик в целях обеспечения:

· безопасности продукции, работ и услуг для окружающей среды, жизни, здоровья и имущества;

· технической и информационной совместимости, а также взаимозаменяемости продукции;

· качества продукции, работ и услуг в соответствии с уровнем развития науки, техники и технологии; единства измерений;

· экономии всех видов ресурсов;

· безопасности хозяйственных объектов с учетом риска возникновения природных и техногенных катастроф и других чрезвычайных ситуаций;

· обороноспособности и мобилизационной готовности страны.

К нормативным документам по стандартизации, действующим на территории нашей страны, относятся:

· государственные стандарты Российской Федерации (ГОСТ Р);

· применяемые в установленном порядке международные (региональные) стандарты;

· правила, нормы и рекомендации по стандартизации;

· общероссийские классификаторы технико-экономической и социальной информации;

· стандарты отраслей;

· стандарты предприятий;

· стандарты научно-технических, инженерных обществ и др. общественных объединений.

Государственные стандарты Российской Федерации — нормативные акты, устанавливающие единые правила в той или иной области деятельности в пределах нашего государства.

Государственные стандарты разрабатываются на продукцию, работу и услуги, имеющие межотраслевое значение.

требований стандартов, области их распространения, сферы их действия и даты их введения определяются государственными органами управления, которые их принимают.

В соответствии с законом «О стандартизации» государственные стандарты и общероссийские классификаторы технико-экономической и социальной информации принимает Госстандарт России, они вводятся в действие после их государственной регистрации.

Требования, устанавливаемые стандартами, являются обязательными для всех государственных органов управления и субъектов хозяйственной деятельности. Госстандарт России и иные, специально уполномоченные государственные органы управления в пределах их компетенции осуществляют госконтроль и надзор за соблюдением обязательных требований государственных стандартов.

Стандарт устанавливает:

· состав реквизитов документов;

· требования к составу реквизитов документов;

· требования к бланкам и оформлению документов;

· требования к изготовлению, учету, использованию и хранению бланков с воспроизведением Государственного герба Российской Федерации, гербов субъектов Российской Федерации.

Все государственные стандарты, действующие на территории нашей страны, объединены в единую Государственную систему стандартизации — иерархически организованную систему классификации и кодирования самих государственных стандартов.

Серия 1 Государственной системы стандартизации содержит комплекс основополагающих стандартов, в которых закреплены положения о порядке разработки государственных стандартов, о построении, изложении и оформлении стандартов, их утверждении, регистрации и введении в действие, о порядке внесения изменений в стандарты, отмены стандартов и др., например: 1 апреля 2000 года введено в действие Изменение № 1 к ГОСТ Р. 6.30-97, принятое Постановлением Госстандарта России от 21 января 2000 года № 9-ст.

Порядок применения и внедрения ГОСТ Р. 6.30-97 разъясняет и конкретизирует в Методических рекомендациях ВНИИ документоведения и архивного дела. Методические рекомендации предназначены для внедрения в организациях:

· единых правил оформления реквизитов документов и вариантов их расположения на основе современной нормативной базы по документационному обеспечению;

· новых информационных технологий подготовки документов и передачи документной информации;

· делового стиля документов, основных требований при составлении и унификации текстов документов;

· правил изготовления документов с помощью печатающих устройств, включая компьютерную текстообработку;

· правил проектирования бланков документов;

· правил использования, учета и хранения бланков и печатей;

· правил оформления документов, предаваемых по каналам электросвязи.

ГОСТ 1.РО-92. Государственная система стандартизации Российской Федерации: Основные положения.

Самостоятельный комплекс стандартов составляют стандарты на унифицированные системы документации и Единую систему классификации и кодирования технико-экономической информации:

Источник: https://mirznanii.com/a/194864/unifikatsiya-i-standartizatsiya-dokumentov-2

О стандартах документации

Стандартизация в оформлении технической документации

Документация – такая штука, к которой мало кто питает тёплые чувства: скучно, занудно, однообразно. И, тем не менее, иногда не возникает сомнений в её необходимости: ведь кому-то после вас этим пользоваться или, тем паче, модифицировать.

И тогда появляется вопрос: как сделать документацию правильно? Существует тьма статей на тему «как писать документацию», но если вы решили взяться за неё в первый раз, то в новой для вас области не сразу понятно, дело ли пишет автор, или отсебятину выдумывает.

Для того чтобы сформировать своё мнение без перелопачивания статей, можно пойти двумя путями: довериться некому авторитету или посмотреть в стандарты – уж там-то с наибольшей вероятностью проблему обдумали со всех сторон.

Кто-то может сказать «а-а, стандарты! они ещё более адово скучные, чем сама документация!».

Ну, не будем врать, есть немного ? Но если у вас документ в электронном формате – найти необходимое не составляет труда. И кроме того, ну надо же размочить раздел стандарты уже, а то висит пустой, даже обидно.

Наши

Обратимся сначала к ГОСТ-ам. Они расстраивают датами разработки (впрочем, похоже, за эти годы в документировании не многе изменилось) и радуют бесплатностью.

ГОСТ Р ИСО 9127-94 «Документация пользователя и информация на упаковке для потребительских программных пакетов» – наиболее приглянувшийся мне стандарт из наших.

Довольно кратко (весь документ – около 20 страниц) указаны основные требования к составу и содержанию документации пользователя.

Официальная страница. Скачать PDF.

ГОСТ Р ИСО/МЭК 15910-2002 «Процесс создания документации пользователя программного средства» — стандарт больше отвечает не на вопрос «Что» должно быть в документе, а «Как» должен создаваться документ.

Дополнительно есть подробное описание стиля документа с примером – довольно удобная штука для создания шаблона: один раз запариваешься (и забиваешь в шаблон всё: от выравнивания до формата подписей рисунков), а потом клепаешь документы все одного вида, а не с заголовками разного шрифта.

Официальная страница. Скачать PDF.

ГОСТ-ы серии 19.хх – серия ЕСПД, страсть, какая древняя (в среднем, документы созданы в 78-м году), но зато такие же лаконичные, как в ГОСТ 9127, требования ко многим видам документов.

Ознакомиться.

ГОСТ 34.602-89 «Техническое задание на создание автоматизированной системы» — стандарт на ТЗ. Спасибо Jazzist.

Буржуйские

Не было предела моему возмущению, когда я узнала, что международные стандарты не бесплатные. Это как правила дорожного движения сделать платными. Но в принципе, может и резонно: организации-то не государственные.

Хотят – могут и деньги брать за свою работу. К счастью, многие стандарты можно скачать по-привычному, по-пиратски.

IEEE Std 1063-2001 «IEEE Standard for Software User Documentation» — в документе обозначены требования к структуре, содержимому и формату инструкций пользователя.

Официальная страница.

IEEE Std 1016-1998 «IEEE Recommended Practice for Software Design Descriptions» — рекомендации к документам, описывающим архитектуру программного обеспечения, то бишь к техническому описанию.

Официальная страница. Особливо понравилась табличка-экстракт основного содержания документа (здесь вольный перевод):

Тип обзора Атрибуты Примеры представления
Декомпозиция Разбиение системы на структурные составляющие Определение, тип, назначение, функции, зависимые сущности Иерархическая диаграмма декомпозиции, словесное описание.
Описание зависимостей Описание связей между сущностями и системными ресурсами. Определение, тип, назначение, зависимости, ресурсы. Структурные схемы, диаграммы потоков данных, схемы транзакций.
Описание интерфейса Список всего, что может потребоваться знать проектировщику, программисту или тестеру для того чтобы использовать структурные составляющие системы. Определение, функции, интерфейсы. Файлы интерфейса, таблицы параметров.
Описание деталей Описание внутреннего устройства частей сущности. Определение, обработка данных,
данные.
Блок-схемы, N-S диаграммы, PDL

ISO/IEC FDIS 18019:2004 «Guidelines for the design and preparation of user documentation for application software» — рекомендации по созданию документации пользователя. Так сказать, советы «хозяйке на заметку». Довольно приятное руководство с большим количеством примеров (имхо, больше подходит для чтения до или в самом начале создания документации, так как подходит к процессу основательно, от самого планирования). Также в приложениях есть чеклисты «что не забыть сделать в процессе разработки документации» и «что должно быть в документе»
Официальная страница.

ISO/IEC 26514:2008 «Requirements for designers and developers of user documentation» — довольно свежий и, судя по содержанию, полезный документ. Но, как раз, видимо, ввиду его свежести, этот стандарт нигде не найти бесплатно. По крайней мере, мне этого сделать не удалось.

Официальная страница. Это были стандарты, наиболее тесно связанные с документированием. Они могут пригодиться как начинающему техпису, так и, например, фрилансеру, который «и швец, и жнец, и на дуде игрец». Уточнения, дополнения и полезные ссылки приветствуются)

UPD

Источник: https://habr.com/post/116825/

Оцените статью
U-Alfa.ru Интернет журнал
Добавить комментарий