- Структура документации системы менеджмента качества
- Постоянная составляющая структуры документации СМК
- Политика и цели в области качества
- Руководство по качеству
- Руководство по качеству
- Содержание руководства
- Документированные процедуры
- Процедура Организация делопроизводства
- Процедура Управление внешней нормативно-технической документированной информацией
- Процедура Управление документацией СМК
- Процедура Управление записями по качеству
- Вывод
- Управление записями по качеству
- Процедура Управление несоответствиями
- Процедура Внутренние аудиты
- Процедура Корректирующие действия
- Процедура Предупреждающие действия
- Процедура Предупреждающие действия
- Область применения
- Порядок действий
- Универсальность процедуры
- Документ
- Карты процессов
- Определение карты процесса
- Виды карт процессов
- Записи по качеству
- Особенности записей по качеству
- Минимальный состав записей по качеству
- Что такое договорные документы
- Виды договорных документов
- Правила работы с договорной документацией
- Сроки и порядок хранения договорной документации
- Почему лучше вести договорную документацию в электронном виде
- Понятие, виды и иерархия в России
- Нормативно правовые акты
- По силе действия
- По территории
- Иерархия нормативных правовых актов
- Советы экспертов
- Что такое Diátaxis?
- Почему Diátaxis хорош?
- Он упрощает жизнь пользователям
- Он упрощает жизнь вам
- Жанры документации
- Концепции
- Справочники
- Директивные жанры
- Гайды
- Туториалы
- Неудачные примеры
- Заключение
- Классификация технологической документации
Структура документации системы менеджмента качества
Структура документации системы менеджмента качества, построенной по стандарту ГОСТ Р ИСО 9001:2015 (ISO 9001:2015), представляет собой иерархическую систему взаимосвязанных документов. Часть этих документов в явном виде оговорена в стандарте, другая часть подразумевается. Поэтому структура системы качества имеет постоянную составляющую, определенную стандартом и переменную составляющую, зависящую от конкретной организации.
Постоянная составляющая структуры документации СМК
Некоторые рекомендации по составлению структуры документации СМК и содержанию документов СМК дает стандарт ИСО 10013:2021 Руководящие указания по документированной информации. Однако, при составлении структуры документации СМК лучше ориентироваться на существующую в организации систему документации, дополняя ее необходимыми документами, требуемыми стандартом ИСО 9001:2015.
Политика и цели в области качества
Политика в области качества это один из стратегических документов организации. В этом документе определяются основные принципы работы и развития ее системы управления в области качества. Как правило, политика в области качества представляет собой декларативный документ. Однако, каждая декларация, заявленная в политике, должна раскладываться на конкретные цели, планы и действия по реализации указанных деклараций. Отсюда появляется и прямая связь политики в области качества с целями в области качества.
Цели в области качества- это документ в котором организация устанавливает каких результатов в области качества она хочет достигнуть. Цели в области качества должны быть направлены на реализацию деклараций политики, но в отличие от политики, цели имеют конкретные показатели, которые можно измерить и достигнуть в ограниченные периоды времени.
Политику и цели в области качества обычно представляют отдельными документами. Либо можно цели в области качества включать в состав политики, но в этом случае политика в области качества будет иметь две части – открытую и закрытую. Открытая часть – это декларации, а закрытая часть – это конкретные и измеримые цели организации.
Руководство по качеству
Стандарт ИСО 9001:2015 (ISO 9001:2015) не требует от организации обязательной разработки руководства по качеству, тем не менее этот документ может оказать организации значительную помощь в структурировании и управлении системой качества.
Руководство по качеству представляет собой документ, описывающий всю систему менеджмента качества организации, а точнее то, каким образом организована система качества, какую структуру она имеет, какова структура документации системы качества. Стандарт ГОСТ Р ИСО 9000:2015 (ISO 9000:2015) дает определение Руководства по качеству в следующем виде: Руководство по качеству – документ, определяющий систему менеджмента качества организации. Это означает, что руководство по качеству должно содержать описание, каким образом организация реализует требования стандарта ИСО 9001:2015.
Руководство по качеству
Руководство по качеству является одной из важных составляющих системы качества. Документ содержит описание системы менеджмента качества, список процессов СМК, состав процедур системы качества, необходимых для выполнения требований стандарта ИСО 9001.
Содержание руководства
В руководстве по качеству представлено, как компания выполняет общие требования к системе менеджмента качества, требования по ответственности руководства компании, требования по управлению ресурсами, управлению процессами жизненного цикла, а также требования по измерению, анализу и улучшению СМК, процессов и организации в целом.
Данное руководство взаимосвязано с другими документированными процедурами СМК.
Документированные процедуры
Процедура Организация делопроизводства
Данная процедура позволяет выполнить часть требований стандарта ИСО 9001:2015 по управлению документированной информацией, она распространяется на документы служебного делопроизводства. Процедура устанавливает правила работы с официальными документами организации.
Процедура Управление внешней нормативно-технической документированной информацией
Данная процедура позволяет выполнить часть требований стандарта ИСО 9001:2015 по управлению документированной информацией, она распространяется на документы внешнего происхождения.
Процедура Управление документацией СМК
В данной процедуре представлен только один вид документации – документы СМК. К ним относятся: руководство по качеству, документированные процедуры, рабочие инструкции, типовые формы документов и записи по качеству.
Процедура Управление записями по качеству
Информация представлена в текстово-графическом виде.
Данная процедура может применяться в оранизациях различных сфер деятельности и с различной численностью персонала.
Вывод
Руководство по качеству позволяет организации придерживаться необходимых стандартов и требований в области управления качеством продукции или услуги, и может значительно повысить эффективность работы организации в целом.
Управление записями по качеству
Данная процедура реализует часть требований стандарта ИСО 9001:2015 по управлению документированной информацией. Эти требования касаются ведения записей по качеству.
Записи по качеству – это документированная информация, которая должна сохраняться в системе качества.
Документ содержит основные положения по управлению записями по качеству, состав записей по качеству, пример ответственных за ведение записей по качеству и названия форм представления записей по качеству.
Процедура может применяться организациями различных видов деятельности и с различной численностью персонала.
Документ включает в себя 11 страниц.
Процедура Управление несоответствиями
В соответствии со стандартом ГОСТ Р ИСО 9001:2015 (ISO 9001:2015) организация должна управлять продукцией и другими результатами своей деятельности, которые имеют отклонения от исходных требований. Такие отклонения называются несоответствиями.
Данная процедура позволяет реализовать все требования п.п. 8.7 стандарта ГОСТ Р ИСО 9001:2015 (ISO 9001:2015) по управлению несоответствиями.
В процедуре представлен порядок регистрации несоответствий, порядок выполнения мероприятий по управлению несоответствиями, состав документов процесса, риски и возможности, связанные с данным процессом.
Процедура является унифицированной и может применять в организациях различных видов деятельности и с различной численностью персонала.
Процедура Внутренние аудиты
Стандарт ИСО 9001:2015 требует от организаций проводить внутренние аудиты.
Процесс аудита должен быть документирован. Процедура Внутренние аудиты позволяет выполнить требования стандарта ГОСТ Р ИСО 9001:2015 (ISO 9001:2015), связанные с внутренними аудитами.
Процедура содержит основные мероприятия по внутреннему аудиту:
- планирование аудита;
- подготовка аудита;
- проведение аудита;
- выполнение мероприятий по результатам аудита.
Кроме того, в состав процедуры включены основные типовые формы, необходимые для проведения внутренних аудитов организации (программа аудита, график аудита, лист несоответствий, отчет по аудиту).
Процедура Внутренние аудиты является унифицированной и может применяться любой организацией независимо от численности персонала, вида деятельности и формы собственности.
Процедура Корректирующие действия
Данная процедура разработана в соответствии с требованиями п.п. 10.2 стандарта ГОСТ Р ИСО 9001:2015 (ISO 9001:2015).
Данная процедра содержит все необходимые мероприятия по управлению корректирующими действиями – схемы процессов выполнения коррекций и корректирующих действий, состав оформляемых документов, указание на ответственных лиц за проведение корректирующих действий, риски и возможности, связанные с данным процессом.
Процедура является унифицированной и может применяться как малыми организациями (численность персонала единицы человек), так и крупными компаниями (численность персонала несколько сотен человек).
Процедура Управление корректирующими действиями применима для организаций различных сфер деятельности.
Процедура Предупреждающие действия
Процедура Предупреждающие действия
Процедура Предупреждающие действия позволяет реализовать требования стандарта ГОСТ Р ИСО 9001:2015 (ISO 9001:2015) по управлению рисками, в частности, реагирование на риски.
Область применения
Область применения процедуры Предупреждающие действия охватывает все уровни управления организацией.
Порядок действий
Порядок действий представлен в виде схем процессов с пояснениями каждого действия.
Универсальность процедуры
Процедура Предупреждающие действия является универсальной и может применяться организациями любых сфер деятельности и с любой численностью персонала.
Документ
Документ включает в себя 12 страниц.
Карты процессов
Прямого требования стандарта ГОСТ Р ИСО 9001:2015 (ISO 9001:2015) о том, чтобы в организации были созданы карты процессов, либо другие документы представляющие процессы нет. Но требования разделов 4.4.1 и 8.1 этого стандарта говорят о том, чтобы организация определила все свои процессы и обеспечила необходимое управление процессами.
Определение карты процесса
Карта процесса это документ, определяющий назначение процесса, его основные результаты и характеристики, а также последовательность операций или действий процесса. Таким образом, карта процесса представляет технологию выполнения процесса. В зависимости от назначения она может представляться с различным уровнем детализации.
Виды карт процессов
Карты процесса могут представляться процессы административного управления, процессы управления ресурсами, процессы контроля, мониторинга и измерений. Одной из разновидностей карты процесса является технологическая карта, представляющая технологические (производственные) процессы. Карты процессов могут оформляться в виде документированных процедур.
Записи по качеству
Стандарт ИСО 9001:2015 не содержит термина записи о качестве, но этот термин подразумевается. Стандарт говорит о том, что организация должна сохранять документированную информацию. Это значит – регистрировать записи по качеству. Записи по качеству – это особый вид документации системы качества.
Особенности записей по качеству
Особенность этого вида документации заключается только в том, что эти документы подтверждают факт выполнения какого-либо действия и меняют свой статус в момент регистрации этого факта. Например, пустая форма, предназначенная для регистрации результатов контроля, является обычным документом системы качества. Как только в эту форму внесены результаты контроля (форма заполнена), эта форма становится записями по качеству.
Минимальный состав записей по качеству
В стандарте ИСО 9001:2015 определен минимальный состав записей по качеству, который должен существовать в организации. При необходимости этот состав записей по качеству может быть расширен самой организацией.
В современном мире бизнеса и юридической сферы правильное и эффективное управление договорной документацией является неотъемлемой частью успешной работы компании. Договорные документы играют важную роль в установлении прав и обязанностей между сторонами, а также в регулировании отношений в рамках сделок и соглашений. Они определяют условия сотрудничества и защищают интересы всех сторон.
Выясним, какие виды документов относятся к договорным, почему важно правильно их оформлять и хранить, а также зачем нужно вести договорную документацию в электронном виде.
Что такое договорные документы
Договорная документация (договорно-правовые документы) представляет собой письменные соглашения, заключаемые между двумя или более сторонами, которые регулируют их взаимоотношения. Эти документы описывают условия и предмет соглашения, устанавливают права и обязанности каждой стороны, а также определяют сроки и порядок выполнения обязательств.
Заключение договорных документов является важным этапом в бизнес-процессе и имеет ряд значительных преимуществ и выгод для сторон, которые вступают в соглашение.
Виды договорных документов
К договорным документам относятся:
Правила работы с договорной документацией
Оформление договорных документов требует точности и внимания к деталям. Правильное составление документов и включение необходимых элементов являются ключевыми аспектами, позволяющими избежать конфликтов в будущем. При работе с договорной документацией важно учитывать следующие правила:
Соблюдение этих правил при оформлении и работе с договорной документацией позволяет создать чётко структурированные документы, которые будут основой для успешного взаимодействия и сотрудничества между сторонами.
Сроки и порядок хранения договорной документации
Как правило, юридически значимые документы должны храниться на протяжении определённого периода времени, установленного законодательством. Сроки хранения могут варьироваться в зависимости от типа документа и отрасли деятельности организации. Например, для налоговой отчётности срок хранения составляет 5 лет, для бухгалтерских документов — 4 года, для трудовых договоров — 75 лет и т.д.
Правильный порядок хранения договорной документации включает не только соблюдение установленных сроков хранения, но и организацию системы архивирования и доступа к документам. Важно создать структурированную систему классификации и индексации договоров для быстрого доступа к документам.
Для обеспечения сохранности документов и предотвращения их потери или повреждения важно применять соответствующие методы хранения. Пример: использование архивных шкафов или специализированных электронных систем управления документами. Важно также предусмотреть резервное копирование и защиту данных от несанкционированного доступа.
Однако с течением времени традиционные методы работы с договорной документацией становятся всё более устаревшими и неэффективными. Сложности в управлении большим объёмом бумажных документов, высокие затраты на их хранение и поиск, а также риски, связанные с потерей или повреждением, стимулируют организации к переходу на электронный документооборот.
Почему лучше вести договорную документацию в электронном виде
Переход на электронную документацию имеет ряд существенных преимуществ, которые делают этот шаг не только логичным, но и необходимым для современных организаций:
Системы электронного документооборота позволяют автоматизировать рутинные процессы, такие как рассмотрение и утверждение документов. Это сокращает время на обработку и ускоряет процессы согласования. Кроме того, электронная документация позволяет вести учёт и мониторинг документов, упрощает поиск и анализ необходимой информации.
Использование электронных документов значительно снижает расходы на печать, доставку, хранение и обработку бумажных документов. Кроме того, риски потери, повреждения или подделки документов существенно сокращаются.
Электронные документы могут быть защищены паролями, шифрованием и другими методами безопасности, что обеспечивает конфиденциальность и предотвращает несанкционированный доступ к важным данным. Также можно устанавливать различные уровни доступа для разных пользователей, контролируя и ограничивая права на просмотр и редактирование документов.
Подключите Доки, чтобы вести договорные документы в электронном виде и обмениваться ими с контрагентами, а также внутри организации. Для доступа к системе не нужно устанавливать никаких программ — достаточно ПК или мобильного устройства с выходом в интернет.
Понятие, виды и иерархия в России
Читать на сайте Ria.ru
Нормативно правовые акты
Нормативно правовой акт – это официальный документ, принятый уполномоченными органами власти и содержащий в себе правовые нормы. "Система нормативных правовых актов в России объединяет в себе правовые акты центральных федеральных органов власти, акты субъектов РФ, местного самоуправления, локальные акты, а также акты, принятые в результате прямого народного волеизъявления", – объясняет Светлана Горохова, кандидат юридических наук, доцент департамента международного и публичного права Финансового университета при Правительстве РФ.
В Госдуму внесли проект о временной приостановке участия России в ДСНВ
"В каждой правовой системе всегда установлена четкая иерархия нормативных правовых актов, что позволяет осуществлять регулирование отношений по единой схеме и понятным критериям. В российской правовой системе есть два глобальных уровня нормативно-правовых актов – законы и подзаконные акты", – комментирует старший вице-президент ИК Fontvielle Анастасия Хрусталева.
Виды нормативно правовых актов классифицируют по двум признакам.
По силе действия
Ø Конституция – главный основополагающий нормативный акт в Российской Федерации. На ее основе и в соответствии с ее руководящими принципами принимаются все остальные нормативные акты страны.
Ø Федеральные законы– нормативные акты, регулирующие общественные отношения на территории всего государства. Оксана Васильева, кандидат юридических наук, доцент департамента правового регулирования экономической деятельности Финансового университета при Правительстве РФ, поясняет, что федеральные законы принимает Государственная Дума, одобряет Совет Федерации и подписывает президент РФ.
По словам Анастасии Хрусталевой, на уровне законов большей юридической силой обладают федеральные конституционные законы, под ними – федеральные законы. Отличия состоят в том, что федеральные конституционные законы прямо упомянуты в Конституции РФ (например,
в ст. 70 Конституции РФ
говорится о федеральном конституционном законе о государственном флаге и на основе этой статьи 25 декабря 2000 года принят нормативный акт
"О Государственном флаге Российской Федерации"). Все остальные законы, которые прямо не упомянуты в Конституции РФ, относят к уровню законов.
"Кстати, кодексы тоже относятся к уровню федеральных законов. Ошибочно полагать, что они имеют большую юридическую силу по отношению к обычным федеральным законам. Кодексы – это та же совокупность норм, только собранных в определенную структуру и регулирующих разные направления отношений в рамках одной отрасли", – говорит эксперт.
Ø Подзаконные акты не могут противоречить никаким федеральным законам. Подразделяются на три вида:
В Госдуму внесли законопроект об особенностях выборов в новых регионах
По словам Анастасии Хрусталевой, в отношении подзаконных актов выделяют достаточно много видов и критериев классификации. В целом, подзаконные акты призваны регулировать отдельные правовые моменты, конкретные ситуации, разъяснять и дополнять нормы права. Иногда они регулируют те отношения, где наблюдается пробел в законодательстве. Иными словами, в некоторых случаях они опережают ситуацию и применяются тогда, когда закон еще не принят.
По территории
Выделяют права и обязанности, которые распространяются на всех граждан. Но есть и те, что действуют только на определенной территории. По территориальному признаку нормативно правовые акты подразделяют на:
Международные нормы права, по словам Анастасии Хрусталевой, являются частью правовой системы России после их подписания (принятия, ратификации, утверждения и т.д.), о чем прямо сказано в Конституции РФ. Однако российский основной закон имеет
над международным правом, Конституционный суд может не исполнять решения международных органов, если они противоречат основному закону.
Иерархия нормативных правовых актов
"Наличие иерархии имеет важное значение, и главная ее функция заключается в том, что нормативные акты каждого нижестоящего уровня могут быть отменены, если они противоречат положениям нормативных актов любого уровня выше. Эта система позволяет избежать хаоса, противоречия одних норм регулирования другим и призвана обеспечить единообразный подход к применению этих норм не только юристами, но и всеми гражданами страны", – поясняет Анастасия Хрусталева.
Светлана Горохова акцентирует внимание на том, что в России до сих пор отсутствует Федеральный закон "О нормативных правовых актах", хотя проекты подобного закона вносились в Госдуму РФ не один раз.
Советы экспертов
По словам Оксаны Васильевой, на практике бывают случаи, когда несколько нормативных актов регулируют одно и то же правоотношение, но кардинально разным образом. В праве это называются коллизией.
Эксперт советует руководствоваться данной таблицей при возникновении противоречий между нормативными актами.
Биометрия как система идентификации: принцип работы, где применяется
Коллизия между нормами (актами)Применяемая норма (акт)
Между Конституцией РФ и международным договором
Между Законом РФ и международным договором РФМеждународный договор РФ
Между Федеральным конституционным законом и Федеральным закономФедеральный конституционный закон
Между Конституцией РФ и Конституциями (Уставами) субъектов федерации
Между общефедеральными актами и актами субъектов РФ
Между законами и иными нормативными правовыми актами
Между актами, принятыми одним и тем же органомАкт, принятый позже всех
Между актами, принятыми разными органамиАкт, принятый вышестоящим органом
Между общим и специальным актамиа) если приняты органами одного уровня, то применяется специальный акт (коллизия по горизонтали);б) если акты приняты органами разного уровня, то применяется акт вышестоящего органа (коллизия по вертикали)
Это первая статья в корпоративном блоге компании documentat.io. Мы занимаемся заказной разработкой технической документации и помогаем компаниям настраивать процессы документирования.
Многие разработчики сталкиваются с тем, что писать и поддерживать документацию трудно: непонятно с чего начать, что и куда написать, и как это безобразие дополнять по мере развития проекта. Часто в результате получается документация, которую тяжело читать. А значит пользователи читать её и не будут, вместо этого будут действовать методом проб и ошибок или дёргать техподдержку. И это в лучшем случае. В худшем — откажутся от использования продукта. В итоге пострадают все: и разработчики, и пользователи, и техподдержка, и бизнес.
Решить эту проблему можно двумя способами:
Рассмотрим второй вариант. Чтобы писать документацию стало проще, нужно продумать её структуру — разделить документацию на жанры и наполнять каждый раздел в строгом соответствии с его жанром. Этот подход придуман давно и встречается в различных книгах для техписателей в разных вариациях. Наиболее современным и эффективным, на наш взгляд, является Diátaxis.
В этой статье разберёмся:
Также мы взглянем на несколько примеров применения и неприменения этого подхода.
Что такое Diátaxis?
Diátaxis — это подход к разработке документации, при котором каждый раздел документации относится к одному из жанров:
Почему Diátaxis хорош?
Он реально упрощает жизнь!
Он упрощает жизнь пользователям
Пользователь никогда не читает документацию от корки до корки. На разных этапах знакомства с продуктом пользователь решает с помощью документации разные задачи:
Наверное, вы заметили, что жанры Diátaxis нацелены на решение каждой из этих задач по отдельности. Такая структура помогает пользователю быстрее сориентироваться и приступить к решению задачи, не отвлекаясь на лишнюю информацию.
Он упрощает жизнь вам
Писать документацию намного приятнее, когда вам не приходится ломать голову, куда положить тот или иной кусок информации.
Как только вы распарсите всю информацию о продукте на жанры, правила этих жанров сделают за вас львиную долю работы. Писать и поддерживать документацию намного проще, когда вы заранее знаете, где и что будет лежать.
Жанры документации
Разделы, написанные в этих жанрах, дают теоретические знания о продукте. Они описывают устройство продукта на разных уровнях, но не содержат прямых указаний и пошаговых инструкций. К описательным жанрам относятся концепции и справочники.
Концепции
Концепции отвечают на вопросы как и почему. Пользователь открывает концепции, чтобы получить общее представление о работе продукта и его составляющих. Здесь вы можете описать:
Это не обязательный и не полный список, здесь есть пространство для творчества.
Но есть и список того, что писать в концепциях не следует:
Примеры хороших концепций:
Справочники
Справочники перечисляют и описывают функциональные составляющие продукта — ключи командной строки, элементы синтаксиса, настройки, параметры, запросы к API, коды ошибок и т. п. К жанру справочников относятся справочники API, выгрузки Javadoc, перечни параметров у CLI-утилит, диаграммы классов в программной системе.
Пользователь читает справочник отрывками, когда ему в процессе работы нужно узнать, как работает конкретный элемент. Следовательно, хороший справочник содержит:
Примеры хороших справочников:
Справочник — это первое, а иногда единственное, что приходит в голову большинства разработчиков, когда речь заходит о документации. Разработчик уже знает, как работает его продукт и как им пользоваться. Поэтому ему кажется, что мелкие технические подробности — это всё, чего не хватает пользователю. Но это не так.
Нельзя научиться пользоваться продуктом, читая список команд, как нельзя выучить английский, читая англо-русский словарь. Эффективное обучение работе с продуктом строится от решения простых учебных заданий уровня «Hello, World» к реальным задачам. Выстроить такое обучение в документации вам помогут разделы, написанные в директивном жанре, — туториалы и гайды.
Директивные жанры
Разделы, написанные в этих жанрах, помогают пользователю сформировать и закрепить практические навыки работы с продуктом. К директивным жанрам относятся гайды и туториалы.
Гайды
Гайд по шагам описывает работу с какой-либо функцией продукта. Пользователь обращается к гайду, когда он уже работает с продуктом и ему нужно понять, как решить возникшую задачу: построить график, отправить API-запрос, изменить настройки и т. п.
Чтобы у вас получился хороший гайд:
А вот чего делать не стоит:
Примеры хороших гайдов:
Обратите внимание, что во втором и третьем примерах одну задачу можно решить четырьмя разными способами. По сути это четыре разных гайда, но они расположены в интерактивных вкладках и не сбивают читателя с толку. Элегантное решение.
Туториалы
Туториалы — это обучающие задачи с явно заданными входными данными и пошаговым решением. При этом решение задачи не является самоцелью туториала. Настоящая цель — сформировать у пользователя навыки работы с продуктом. Пользователь открывает туториал, чтобы научиться использовать продукт.
Чтобы написать хороший туториал:
Примеры хороших туториалов:
Неудачные примеры
Хорошие примеры следования отдельным жанрам приведены в разделах этой статьи. Примеры документации, которая целиком построена по Diátaxis, вы можете найти на сайте Diátaxis.
Здесь же мы рассмотрим несколько примеров документации, которая на наш взгляд выиграла бы в полезности и эффективности, если бы была построена с учётом описанного подхода.
Заключение
Diátaxis — это эффективный подход, который построен на надёжных принципах из теории обучения и используется в ряде крупных продуктов. Он помогает структурировать документацию так, чтобы вам стало проще её писать, а пользователям проще извлекать из неё информацию.
Для грамотного применения Diátaxis тщательно следите, чтобы информация, которая относится к одному жанру, не просачивалась в разделы, написанные в другом. Иначе структура вашей документации быстро деградирует до такого состояния:
При этом не стоит воспринимать предложенный набор жанров и их интерпретацию, как строгий стандарт. Только вы можете определить, какой объём и содержание документации необходимы вашему продукту.
Чтобы документация работала эффективно, и это не был Diátaxis ради Diátaxis, используйте следующий подход:
Мы надеемся, что статья была полезной и изложенная парадигма поможет вам в разработке документации. Пишите в комментариях, какие подходы к структуре документации используете вы. А если вы вообще не очень любите писать документацию, доверьте это нам — обращайтесь в documentat.io!
Редактор: Ната Мелихова
Во второй статье из серии об организации производства в России рассмотрим основные виды технологических документов и расскажем, какие из них обязательно должны быть у российского производителя, а какие требуются при оценке соответствия продукции.
Технологические документы разрабатываются для стандартизации производственных процессов. Именно они содержат описание последовательностей действий изготовителя, обеспечивающих качество производимой продукции, а также её соответствие требованиям безопасности, условиям эксплуатации, хранения и транспортировки.
Классификация технологической документации
В зависимости от применяемых стандартов, в разных странах схожие по содержанию технологические документы могут иметь различные названия и классификации. Так, европейские производители составляют технический файл — комплект технической документации с требованиями к проектированию, производству, обращению, эксплуатации и утилизации продукции.
Для каждого производства технический файл разрабатывается индивидуально, но в любом случае он должен содержать обязательные элементы:
Технический файл должен храниться у производителя не менее 10 лет с момента выпуска продукции на рынок.
На российских производствах при разработке технологической документации руководствуются требованиями ГОСТов, например, ГОСТ 3.1102-2011 «Единая система технологической документации. Стадии разработки и виды документов. Общие положения».
Таблица. Классификация технологической документации
По стадиям производственного цикла Конструкторская Проектная Эксплуатационная Ремонтная Организационная
По стадиям разработки Предварительный проект Документация для опытного образца или партии Документация для серийного производства
Основная Вспомогательная Специальная
По видам документов Технические условия (ТУ) Технологическая инструкция (ТИ) Технологический регламент (ТР) Технологический процесс (ТП) Паспорт безопасности (ПБ) Этикетка Рецептура Паспорт качества
Отдельными нормативными актами на предприятии можно утвердить свои виды документов с требованиями к технологическому процессу, например: проекты производства работ, технологические карты, маршрутные карты, ведомости, схемы соединений и другие.
