Тема 21. Техническая документация контроля.

Техническую документацию контроля разделяют на три вида:

1. Технологическая документация;

2. Сопроводительная документация;

3. Накопительная документация.

Под технологической документацией понимают операционные карты и ведомости операций.

Операционные карты (ОК) и ведомости операций (ВОП) используют для описания технологических операций и технологических процессов технического контроля. В составе комплекса ЕСТД разработан ГОСТ 3.1502-85 « ЕСТД. Формы и правила оформления документов на технический контроль».

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

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

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

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

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

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

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

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

Для разработки технологической документации на испытания в составе ЕСТД разработан ГОСТ 3.1507- 84 «ЕСТД. Правила оформления документов на испытания». Их разрабатывают в форме маршрутных карт (МК).

Совместно с ОК, ВОП и МК могут применяться карты эскизов (КЭ), на которых помещаются графическое изображение зоны изделия, подлежащие контроля или испытаниям, таблицы контролируемых параметров, схемы и т. п.

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

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

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

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

Технологический паспорт оформляется также на специфические технологические процессы, например, когда время выполнения отдельных операций или между их выполнением регламентировано. Этот документ после приемки и сдачи изделия хранится в ОТК весь период, рассчитанный на эксплуатацию изделия. В технологический паспорт могут входить вспомогательные документы: карты измерений и испытаний. Их используют для регистрации результатов измерения контролируемых параметров при изготовлении изделий и регистрации условий, режимов и контролируемых параметров при проведении испытаний. На картах проставляются даты выполнения и подписи исполнителей.

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

Сопроводительный ярлык является разновидностью технологической бирки при изготовлении большой партии.

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

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

Акты о браке оформляются контролерами БТК. Он является основным первичным документом для учета и анализа брака. Браком считается продукция, которая по своему качеству не соответствует НТД. На основании актов составляются сменные или ежедневные сводки по браку. Они позволяют более углубленно изучать причины брака с целью разработки эффективных мероприятий по его устранению.

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

Накопительная документация позволяет получить историю качества по выпуску продукции данного типа с целью управления процессом изготовления продукции и прогнозирования её качества.

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

При анализе причин брака принимают во внимание следующие принципы:

•Сначала формируются предположение (версия), которая затем уточняется путём проведения определённой исследовательской работы;

•Область поиска причин дефектности сужают, переходя от общего к частному;

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

•Анализ причин дефектности должен быть направлен на выявление причино-следственных связей;

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

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

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

1. КОНСТРУКТИВНЫЕ ПРИЧИНЫ. Они являются следствием несовершенства методов расчёта, недостаточным учётом реальных условий эксплуатации и ошибками в проектировании изделия и технологической подготовке производства.

2. ПРОИЗВОДСТВЕННЫЕ ПРИЧИНЫ. Они являются следствием отклонений в производственных процессах изготовления изделий. Производственные причины, как и дефекты, можно разделить на металлургические и технологические причины.

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

Технологические причины связаны с:

• неудовлетворительной подготовкой поверхности;

• низким качеством сборки;

• нарушением технологии сварки;

• низкой квалификацией сварщиков;

• неисправностью оборудования;

• неблагоприятными производственными условиями.

3. ЭКСПЛУТАЦИОННЫЕ ПРИЧИНЫ. Они связаны с нарушением условий эксплуатации изделий.

КОНТРОЛЬ КАЧЕСТВА ПРОДУКЦИИ

КОНТРОЛЬ КАЧЕСТВА ПРОДУКЦИИ — проверка соответствия качества продукции или процесса, от которого оно зависит, установленным требованиям. Контроль качества продукции включает государственный надзор за качеством продукции, ведомственный контроль качества продукции и технический контроль качества в объединениях, предприятиях и организациях.

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

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

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

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

Контроль качества продукции в объединениях и на предприятиях проводится отделами технического контроля (ОТК). Начальник ОТК имеет право прекращать приемку продукции, запрещать использование в производстве предметов и средств труда, не соответствующих требованиям, останавливать выпуск продукции в подразделениях, не соблюдающих технологическую дисциплину; он несет уголовную и материальную ответственность за выпуск некачественной и некомплектной продукции.

Улучшению контроля качества продукции способствует введение самоконтроля исполнителей, предоставление им права личного клейма.

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

Технический контроль качества продукции на стадиях ее жизненного цикла

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

Объектами технического контроля являются:

• продукция;

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

• техническая документация.

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

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

Основными задачами контроля качества при разработке являются:

• оценка уровня качества разрабатываемых изделий;

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

• проверка выполнения требований стандартов ЕСКД, ЕСТД, ЕСТПП и других нормативных документов, предъявляемых к процессу разработки и к разрабатываемой документации;

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

Объектами контроля качества при разработке изделий являются:

• конструкторская документация;

• технологическая документация;

• опытный образец изделия, макет, модель;

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

• метрологическое обеспечение разработки.

При контроле конструкторской документации проверяется соответствие отраженных в ней проектных решений требованиям технического задания или технических условий на изделие; соответствие состава и содержания документации требованиям стандартов ЕСКД и других нормативных документов; технологичность изготовления разработанной конструкции и ее составных частей.

При контроле технологической документации проверяется соответствие технологических процессов и операций изготовления опытного образца требованиям конструкторской документации; рациональность способов изготовления, сборки, регулировки и испытаний образца; правильность оформления документов в соответствии с требованиями стандартов ЕСТД и других НТД; соответствие изготовленного по разработанным технологическим процессам опытного образца требованиям, установленным в техническом задании и в конструкторской документации.

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

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

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

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

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

Объектами контроля в процессе производства являются:

• материалы, полуфабрикаты и комплектующие изделия;

• заготовки, составные части изделия (детали, сборочные единицы и комплекты), готовые изделия;

• технологические процессы ;

• технологическое оборудование (в том числе испытательное) и оснастка;

• конструкторская и технологическая документация;

• средства контроля.

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

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

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

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

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

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

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

На стадии эксплуатации оценку уровня качества изделий проводят с целью:

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

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

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

При этом задачами контроля качества являются:

• проверка соответствия показателей качества изделий требованиям НТД при хранении, транспортировании и использовании;

• проверка соответствия показателей качества изделий требованиям НТД после их ремонта и технического обслуживания;

• проверка правильности эксплуатации изделий.

Объектами контроля являются:

• изделия, находящиеся в эксплуатации;

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

Технический контроль качества продукции на стадиях ее жизненного цикла

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

Объектами технического контроля являются:

• продукция;

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

• техническая документация.

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

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

Основными задачами контроля качества при разработке являются:

• оценка уровня качества разрабатываемых изделий;

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

• проверка выполнения требований стандартов ЕСКД, ЕСТД, ЕСТПП и других нормативных документов, предъявляемых к процессу разработки и к разрабатываемой документации;

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

Объектами контроля качества при разработке изделий являются:

• конструкторская документация;

• технологическая документация;

• опытный образец изделия, макет, модель;

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

• метрологическое обеспечение разработки.

При контроле конструкторской документации проверяется соответствие отраженных в ней проектных решений требованиям технического задания или технических условий на изделие; соответствие состава и содержания документации требованиям стандартов ЕСКД и других нормативных документов; технологичность изготовления разработанной конструкции и ее составных частей.

При контроле технологической документации проверяется соответствие технологических процессов и операций изготовления опытного образца требованиям конструкторской документации; рациональность способов изготовления, сборки, регулировки и испытаний образца; правильность оформления документов в соответствии с требованиями стандартов ЕСТД и других НТД; соответствие изготовленного по разработанным технологическим процессам опытного образца требованиям, установленным в техническом задании и в конструкторской документации.

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

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

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

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

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

Объектами контроля в процессе производства являются:

• материалы, полуфабрикаты и комплектующие изделия;

• заготовки, составные части изделия (детали, сборочные единицы и комплекты), готовые изделия;

• технологические процессы ;

• технологическое оборудование (в том числе испытательное) и оснастка;

• конструкторская и технологическая документация;

• средства контроля.

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

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

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

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

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

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

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

На стадии эксплуатации оценку уровня качества изделий проводят с целью:

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

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

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

При этом задачами контроля качества являются:

• проверка соответствия показателей качества изделий требованиям НТД при хранении, транспортировании и использовании;

• проверка соответствия показателей качества изделий требованиям НТД после их ремонта и технического обслуживания;

• проверка правильности эксплуатации изделий.

Объектами контроля являются:

• изделия, находящиеся в эксплуатации;

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

Контроль качества. Технический контроль. Виды контроля.

Стабильность качества в значительной мере зависит от выбранного вида и метода контроля.

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

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

Контроль качества может быть сплошным — проверка каждой единицы продукции и выборочным — проверка определенной части (выборки) из партии изделий.

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

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

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

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

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

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

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

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

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

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

Техническая документация | Определение, структура, советы

Что такое техническая документация?

Что такое техническая документация?

Проще говоря, техническая документация — это часть информации о продукте, которая объясняет продукт и позволяет пользователям реально его использовать. Поэтому речь идет не о рекламе и пресс-релизах, а о «жестких» фактах. Техническая документация может выглядеть очень по-разному, конечно, в зависимости от продукта. Распечатанные инструкции для Airbus займут целые комнаты; инструкции для нового iPhone, с другой стороны, содержатся в крошечной брошюре (с дополнительной информацией о самом устройстве в цифровой форме).

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

Какие документы составляют техническую документацию изделия?

Какие документы составляют техническую документацию изделия?

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

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

Структура и содержание: что должна включать в себя техническая документация?

Структура и содержание: что должна включать в себя техническая документация?

Содержание руководства по эксплуатации, конечно же, также зависит от продукта. Но есть некоторые фиксированные константы, применимые ко всем устройствам:

 

• Все руководства должны содержать указания по технике безопасности.

• В технической документации также необходимо изображение и/или описание устройства.

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

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

• Но это не обязательно должно быть все в одном документе; его можно разделить между рядом документов.

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

Какие требования должны быть соблюдены и что необходимо учитывать?

Какие требования должны быть соблюдены и что необходимо учитывать?

Если вы много знаете о компаниях-производителях, то знаете, что техническая документация во многом связана со стандартами и директивами. Во-первых, документация должна учитывать все стандарты, применимые к вашей отрасли и вашему продукту (например, Директива по машинному оборудованию 2006/42/EC). Существует также большое количество стандартов, касающихся процессов, управления качеством (например, DIN 9001) и формат текста (например, DIN 1450) в целом.

Наконец, существуют специальные стандарты для руководств пользователя и других технических документов (например, DIN 82079-1). Все становится еще сложнее, когда продукция экспортируется, поскольку разные целевые рынки, естественно, имеют свои собственные стандарты. К этому добавляются стандарты перевода инструкций. И последнее, но не менее важное: у большинства компаний также есть свои собственные внутренние нормы и стандарты для управления качеством своих руководств и инструкций. Всего значительное количество стандартов.

Из чего состоит хорошая техническая документация?

Из чего состоит хорошая техническая документация?

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

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

С точки зрения компании также важно, чтобы руководство было завершено вовремя (т. е. было готово к моменту доставки продукта). В конце концов, поскольку инструкции по эксплуатации являются неотъемлемой частью продукта, продукт не может продаваться без инструкций. И последнее, но не менее важное: руководство по эксплуатации должно быть составлено максимально эффективным и экономичным способом.

Редакционное руководство, руководство по документации, руководство по стилю?

Редакционное руководство, руководство по документации, руководство по стилю?

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

► Дополнительная информация

Достижение оптимальной разборчивости текста?

Достижение оптимальной разборчивости текста?

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

► Подробнее

Кто создает техническую документацию?

Кто создает техническую документацию?

Техническая документация создается техническими писателями в отделах технического письма.

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

Что на самом деле делает хороший технический писатель?

Что на самом деле делает хороший технический писатель?

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

► Подробнее

Английская документация, немецкий технический писатель — как это возможно?

Английская документация, немецкий технический писатель — как это возможно?

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

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

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

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

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

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

Какие распространенные проблемы возникают при создании технической документации?

Какие распространенные проблемы возникают при создании технической документации?

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

Еще одна проблема связана с вариантами. Ассортимент продукции современных производителей зачастую сильно кастомизирован: покупатель может выбрать практически любой понравившийся товар. Отделы технического письма также должны уметь отражать эту индивидуальность, чтобы клиентам всегда давали объяснения только по функциональности их конкретной версии продукта. Другие варианты документов производятся для различных целевых групп (базовая и профессиональная версии), а также для различных языковых вариантов и региональных различий (переводы, версии для рынка Великобритании и США). Мощная и эффективная система управления контентом также помогает отслеживать эти проблемы.

Как я могу убедиться, что дизайн удобен для пользователя?

Как я могу убедиться, что дизайн удобен для пользователя?

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

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

Что понимается под управлением терминологией в технической документации?

Что понимается под управлением терминологией в технической документации?

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

Дополнительную информацию см. в следующих статьях:

► Терминология, разработанная собственными силами

► Управление терминологией: призыв к ясности и понятности

Что такое метаданные в технической документации?

Что такое метаданные в технической документации?

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

Хотите узнать больше?

► Кому вообще нужны метаданные?

Что такое «контролируемый язык»?

Что такое «контролируемый язык»?

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

Хотите узнать больше?

► Меньше значит больше: контролируемый язык для более эффективной документации

Стандарты и нормы технической документации

Стандарты и нормы технической документации

Стандарты и нормы играют важную роль в технической документации. Во-первых, это стандарты самого продукта. Документация должна учитывать их и явно называть. Есть также некоторые стандарты, которые применяются к инструкциям по использованию и работе в отделах технического письма. В центре внимания находятся «Стандарты руководств пользователя» DIN EN 82079.-1 и ISO 20607. Существуют также более общие стандарты, например стандарты управления переводами (например, ISO 17100) или управления качеством (например, ISO 9001). И последнее, но не менее важное: многие отделы технического письма создают свои собственные стандарты, в которых они фиксируют дизайн и формулировку инструкций по эксплуатации.

Хотите узнать больше?

► Нормы и стандарты технической документации – где посмотреть

Что такое БЕЗОПАСНАЯ формула для технической документации?

Что такое БЕЗОПАСНАЯ формула для технической документации?

Одной из наиболее важных функций руководств пользователя является предотвращение повреждения имущества и травм. Поэтому отделы технического письма разработали свои собственные стандарты для разделов безопасности и предупреждений. Наиболее важным принципом является так называемая формула БЕЗОПАСНОСТИ, которая описывает, как указывается уровень опасности и как сочетать описание опасности с мерами по ее предотвращению.

Хотите узнать больше?

► Как предупреждать – навык, которому нужно учиться

Как можно оптимизировать процессы рецензирования технической документации?

Как можно оптимизировать процессы рецензирования технической документации?

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

► Улучшение процессов рецензирования в техническом письме

Зачем техническим писателям нужны 3D-модели?

Зачем техническим писателям нужны 3D-модели?

3D-модели имеют много преимуществ для технических писателей. Они понятнее, чем текст или простые иллюстрации. Пользователь может выбрать угол обзора, а также приблизить объект или постепенно разобрать его на составные части. Более того, 3D-модели можно использовать в качестве инструмента навигации: просто щелкнув деталь, вы откроете соответствующую страницу описания. И последнее, но не менее важное: 3D-модели — хорошая отправная точка для анимации в руководствах. Понятно, что 3D-модели могут играть важную роль в документации.
 

► Узнайте больше о технической документации и 3D

Как программное обеспечение может помочь технической документации?

Как программное обеспечение может помочь технической документации?

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

 

Что такое компонентная система управления контентом? Какие преимущества дает CCMS?

Какие преимущества дает CCMS?

Модульность вашего контента

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

► Модульность для начинающих

Хорошее сцепление с переводом

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

Простое создание целевого формата

XML разделяет макет, содержимое и структуру. Макет создается автоматически. Если внешний вид изменяется или требуется содержимое в другом формате, изменяется только макет; контент можно просто опубликовать еще раз. Все, что нужно, это нажать кнопку — никаких знаний в области программирования не требуется! С компонентной системой управления контентом компоновка и вывод вашей технической документации становятся детской игрой. Вы экономите свое время, деньги и нервы. Или, другими словами: компоновка и формат вывода в технической документации никогда не были проще!

Простое управление вариантами

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

Сэкономьте время, деньги и нервы

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

 

Уменьшить подверженность ошибкам, повысить качество

Компонентная система управления контентом автоматизирует и упрощает процессы в вашем отделе технических текстов. Ваша документация становится гораздо менее подверженной ошибкам, и в то же время ее качество значительно улучшается. Вас интересует компонентная система управления контентом? Тогда взгляните на наши  SCHEMA ST4 система авторинга может предложить.

 

Зачем разделять содержание, структуру и макет в технической документации?

Зачем разделять содержание, структуру и макет в технической документации?

Процесс разделения содержимого, структуры и макета изначально кажется шагом назад. В конце концов, WYSIWYG уже много лет является стандартным подходом к созданию документов. Если вы хотите эффективно использовать большое количество документов, то предпочтительным методом является разделение макета, структуры и содержимого. Вы получаете возможность повторного использования и нейтральность в отношении СМИ. Блоки контента можно повторно использовать в совершенно разных контекстах и ​​размещать для каждого возможного (печатного и онлайн) формата. Одни и те же фрагменты текста могут затем появляться в самых разных контекстах — в печатном руководстве или как часть интерактивной функции справки на дисплее машины.

► Зачем разделять контент, структуру и макет?

Что такое СХЕМА ST4?

Что такое СХЕМА ST4?

SCHEMA ST4 — это компонентная система управления контентом (CCMS), или, другими словами, авторская система, в которой контент создается и поддерживается в модулях. Модульная конструкция позволяет гибко комбинировать контент и использовать его во многих различных контекстах, например, в качестве мастер-копии, веб-страницы, базы данных знаний или мобильного приложения. Мощный и настраиваемый механизм макета SCHEMA ST4 автоматически создает правильный макет для каждой публикации.

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

► Подробнее о SCHEMA ST4

Что такое доставка контента?

Что такое доставка контента?

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

► Подробнее о Quanos InfoCube

Какую роль играет техническая документация в программных проектах?

Какую роль играет техническая документация в программных проектах?

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

 

В чем разница между документацией по программному обеспечению и другими руководствами?

В чем разница между документацией по программному обеспечению и другими руководствами?

Документация по программному обеспечению

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

► Проблемы с документацией по программному обеспечению и способы их решения

Наши тематические страницы

5 шагов по созданию технической документации, которая (на самом деле) полезна

«Back to Planio Blog

Jory Mackay 15 ноября 2018 г.

• Twitter Icon
• ICON Facebook
• Linkedin ICON
• XING ICON
• 39393939393939393939393

  9.0004.

  Джори — писатель, контент-стратег и отмеченный наградами редактор Unsplash Book. Он участвует в Inc., Fast Company, Quartz и других компаниях.

  15 ноября 2018 г. · 11 минут чтения

  🎁 Бонусный материал: Шаблон технической документации

  
  
  

  Пока у нас есть инструменты, в использовании которых нам нужна помощь (и язык для общения друг с другом), мы у меня была техническая документация. (Не верите? Первый пример технического письма на английском языке восходит к Средним векам, когда Чосер написал руководство по астролябии — устройству, используемому для измерения расстояния до звезд).

  Написать свой собственный? Вот бесплатный шаблон и контрольный список!

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

  Загрузить бесплатный шаблон

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

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

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

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

  Но сначала краткий обзор этой статьи:

  Когда, почему и как правильно использовать техническую документацию

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

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

  Вот несколько примеров того, где и как вы можете использовать техническую документацию:

  • Поддержка конечных пользователей: помогает пользователям использовать ваш продукт.
  • Маркетинговая поддержка: Все, что ориентировано на продукт и используется для продвижения вашей компании (например, поясняющие видеоролики, презентации или технические целевые страницы)
  • Поддержка разработки: Это могут быть функциональные и технические спецификации, руководства по разработке программного обеспечения или просто процедуры и инструменты, помогающие вашим разработчикам выполнять свою работу.
  • Организационная поддержка: Информация о вашей компании, структуре, процедурах, рабочих процессах, политиках и все остальное, что необходимо знать коллегам для выполнения своей работы.

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

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

  Так как же создавать эти четкие, лаконичные и удивительно полезные документы?

  Написать свой собственный? Вот бесплатный шаблон и контрольный список!

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

  Скачать бесплатный шаблон

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

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

  Шаг 1. Проведите исследование и создайте «План документации»

  Как говорится в старой поговорке: «Пиши то, что знаешь».

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

  Если вы не являетесь экспертом в предметной области, это может означать проведение некоторых внутренних интервью и налаживание отношений с технической командой, чтобы лучше понять материал (и избежать того, что старший технический писатель Уилл Келли называет «Миссия невыполнима»). написание проектов). Или это может быть так же просто, как просмотреть существующие ресурсы и руководства и провести краткий аудит того, что у вас есть и чего не хватает.

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

  • Цели: Проще говоря, что вы хотите, чтобы люди могли делать? Это использование вашего продукта? Найти справочные документы быстро и легко? Узнать, как использовать определенные аспекты вашего инструмента? Разрешить товарищам по команде запрашивать ресурсы или выполнять заказы? Наличие и знание четкой цели имеет важное значение для написания хорошей технической документации и поможет информировать обо всем, что вы делаете.
  • Существующие ресурсы: Что сейчас доступно? Вы обновляете или объединяете текущие ресурсы или начинаете с нуля? Есть ли старые, устаревшие версии, которые нужно убить? Проведите быстрый аудит и найдите все, что поможет вам написать или запутает вашу аудиторию, если они это найдут.
  • Руководства по стилю: Некоторые отрасли требуют, чтобы вы писали техническую документацию особым образом (например, руководство на простом языке для государственных сайтов или упрощенный технический английский для аэрокосмических, авиационных или оборонных компаний). В других случаях у вашей компании может быть руководство по стилю, в котором объясняется, какой язык использовать, как общаться с пользователями и даже грамматические стили.
  • Список тем: Какие темы и подтемы вы будете освещать в своей технической документации? Думайте об этом как о содержании и постарайтесь перечислить все основные разделы и подразделы, которые, по вашему мнению, вам понадобятся.
  • Инструменты и управление: Какое программное обеспечение, инструменты или веб-сайты будут использоваться для создания документации и управления ею? Ссылка на соответствующие руководства по стилю.
  • Крайний срок и окончательные результаты: Когда это должно произойти и в каком формате? Техническая документация касается не только содержания, но и структуры и доставки. И знание того, как контент будет представлен до того, как вы начнете, подскажет вам, что вам нужно и куда приложить свои усилия.

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

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

  Вот несколько советов для каждого из них:

  Используйте шаблоны или «схемы» для единообразия on-page design

  Вы когда-нибудь пролистывали руководство пользователя или открывали справку и сразу знали, что это плохо?

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

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

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

  • Заголовок: Что это?
  • Подзаголовок: Дополнительная информация
  • Обзор : что вы узнаете
  • СОДЕРЖАНИЕ: Внутренняя навигация
  • Особенности: Каждое раздел
  • Особенности: Каждая раздел
  • Особенности: . помочь пользователю

  Вот пример использования вики Planio:

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

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

  Создайте простую, логичную структуру навигации

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

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

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

  Шаг 3: Создайте контент

  Хорошо! С вашим планом документации и структурируйте , пора серьезно заняться созданием вашей технической документации.

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

  Начните с черновика

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

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

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

  Несколько простых советов по грамотному письму:

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

  1. Пишите как человек : По возможности используйте простой и понятный язык. Мы все читали эти документы, которые звучат так, как будто Google Translate пошло не так. Если вы обнаружите, что скатываетесь к неуклюжим предложениям или сложному языку, отойдите на несколько минут. Иногда возвращение к тексту после небольшого перерыва — это все, что нужно, чтобы освежить свой разум.
  2. Помните, ваши читатели — это не вы: Золотая заповедь технического письма — не бери на себя . Вы можете подумать, что говорите откровенно, но вы должны четко осознавать уровень знаний вашей аудитории. Не думайте, что они знают хотя бы половину того, что знаете вы.

     Золотая заповедь технической письменной речи: «Не умышляй». Вам может показаться, что вы говорите очевидно, но вы должны знать, на каком уровне знаний находится ваша аудитория.

  3. Пишите столько, сколько нужно, чтобы быть полезным, и ни слова больше: Короткий текст — это хорошо. Используйте форматирование, чтобы разбить большие куски текста и сохранить четкость в центре. Как пишет технический писатель Amazon Том Джонсон: «Хороший технический писатель сокращает количество слов до нужной краткости, не будучи непонятным».
  4. Помните о силе визуальных эффектов: Это еще одно клише, но изображения действительно говорят тысячу слов. По возможности визуализируйте то, что вы говорите, а не пытайтесь объяснить это.

  Используйте правило 30/90, чтобы получить обратную связь

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

  Если вы не являетесь экспертом в теме, о которой пишете, рекомендуется пригласить профильного эксперта (SME) после первого и окончательного черновика для проверки. Предоставление обратной связи — это навык сам по себе. А когда дело доходит до технической документации, один из лучших способов оформить ее — это то, что Джейсон Фридман называет «30/9».0 отзывов».

  При 30% готовности (ваш первый черновик или набросок) вы не просите подробного отзыва или рецензирования или опечаток и грамматики, а скорее, чтобы рецензент участвовал в более широком наброске, потоке и структуре документ. В то время как на 90% выполнен (ваш окончательный проект), вы просите их тщательно изучить документацию и придираться к любым проблемам.

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

  Получите рецензирование и внесите исправления

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

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

  Редактировать, редактировать и еще раз редактировать

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

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

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

  Шаг 4. Доставка и тестирование

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

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

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

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

  Наконец, проверьте удобство использования/UX . Пользователи теряются или путаются? Получают ли они ответы, которые искали (или думали, что получают, основываясь на заголовках или навигации?). Опыт пользователя сводится к большему, чем просто то, что вы написали. Потратьте время на работу со сторонними тестировщиками, чтобы убедиться, что когда реальные пользователи приходят к вашим документам, они уходят довольными.

  Шаг 5. Создайте график обслуживания и обновления

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

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

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

  4 дополнительных качества отличной технической документации

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

  1. Эффективность разработки и использования: Дублированный контент, неорганизованные структуры и нечеткие процессы могут убить техническую документацию. Используйте такой инструмент, как Planio вики , чтобы содержание было организованным и эффективным.
  2. Актуальная информация: Нет смысла давать пользователям неверную информацию или показывать им устаревшие скриншоты, которые не похожи на то, с чем они имеют дело. Держите свою техническую документацию в актуальном состоянии.
  3. Последовательный дизайн и структура: Каждый раз, когда вы вступаете в контакт со своими пользователями, это время для создания вашего бренда. Придерживайтесь своего дизайна, стиля и тона во всей онлайн-документации.
  4. Доступен в любом месте : Мобильные устройства захватывают мир. Ваша техническая документация, как и остальная часть вашего веб-сайта или приложения, должна быть адаптивной и обеспечивать удобство работы пользователей на всех устройствах.

  Техническая документация может воодушевить или разочаровать — выбор за вами

  Легко недооценить роль технической документации в успехе вашей компании.