Оформление технического документа в соответствии с заданным стандартом (А/01.4) - трудовая функция, присвоенная профессиональным стандартом рабочим и служащим, квалификация которых позволяет занимать должности технического писателя-стажера, младшего технического писателя или оформителя технической документации.
Иными словами - какие обязанности придется выполнять, какие умения и знания должны быть присущи для этого техпису (стажеру или младшему). Или господину оформителю, чтобы занять самую достойную и самую низовую ступень в структуре писательской иерархии. Редакция от 23.10.2020.
3.1.1 Оформление технического документа в соответствии с заданным стандартом (А/01.4)
Смотрите: |
Создан 20.10.2020 15:33:49
Трудовые действия
Создание шаблона документа для заданного текстового процессора
Немного терминологии.
Шаблон (стереотип) (Boilerplate) - Сохраненный текст, предназначенный для повторного использования в многочисленных документах [из п. 23.04.05 ГОСТ Р ИСО/МЭК 2382-23-2004]. Ключевое слово - «многочисленный».
Текстовый процессор (Text, word processor) - Пакет программ и (или) устройство с соответствующим пакетом программ, позволяющие пользователю проводить обработку текстов [из п. 23.01.03 ГОСТ Р ИСО/МЭК 2382-23-2004].
Текстовых процессоров развелось сейчас превеликое множество. Но чаще всего в требованиях к документации во всевозможных технических заданиях прописывается выходной формат doc или docx, что стимулирует к применению OpenOffice и даже Microsoft™ Word. Самый простой и доступный способ создания шаблона документа для Microsoft™ Word расписан в короткой и злой статье Документ Microsoft Word'а в качестве шаблона AuthorIT.
Способ не затратный по времени, не вызывает умственного пресыщения и усталости, но желательно, чтобы электронный документ, избранный в качестве шаблона, предварительно и без замечаний прошел нормоконтроль.
Применение к тексту документа стилей и других средств оформления
Стиль (Style) - Определенный набор инструкций по форматированию текста, позволяющих пользователю применять различные атрибуты с целью унифицировать форму документа путем применения единых характеристик для различных частей текста документа [из п. 23.06.37 ГОСТ Р ИСО/МЭК 2382-23-2004].
Стиль - Перечень связанных с информационным объектом правил, регламентирующих отображение данных на устройстве вывода (шрифта, размера, цвета и т.д.) [из п. 3.1.8 ГОСТ 2.601-2013].
Больше у автора нету, разве что Стиль изложения, язык и оформление документации [из подр. 5.2 ГОСТ Р 54087-2017], но там больше по изложению. Хотя и полезно, чтобы кругозор выходил за все мыслимые и немыслимые рамки, пределы и горизонты.
В общем, выделяют текст, затем правой кнопкой устройства типа «мышь»... Хотя способов применения стилей немерено, а про другие средства оформления автор не понял, отсутствует какая-либо конкретика.
Создание в документе информационно-поискового аппарата
Информационный поиск (Information retrieval) - Действия, методы и процедуры, позволяющие осуществлять отбор определенной информации из массива данных [из п. 3.1.3 ГОСТ 7.73-96].
Автоматизированный информационный поиск - Информационный поиск с использованием ЭВМ [из п. 3.4.2 ГОСТ 7.73-96].
Аппарат издания, вспомогательный текст (back matter, subsidiaries) - Совокупность дополнительных элементов издания, призванных пояснять основной текст, способствовать усвоению содержания вошедших в издание произведений, облегчать читателю пользование изданием, а также помогать его обработке в статистических, библиотечно-библиографических и информационных службах. Примечание - В зависимости от наполнения и функционального назначения выделяются сопроводительный, или научно-вспомогательный аппарат издания, содержащий сопроводительную(ые) статью(и) и комментарии/примечания; справочно-поисковый аппарат издания, состоящий из библиографических ссылок и прикнижного/пристатейного библиографического списка [из пп. 3.1.1.6 ГОСТ Р 7.0.3-2006].
Больше ничего подходящего не найдено, но в целом смысл понятен. Как это делается в современных текстовых процессорах - автору доподлинно неизвестно, поскольку надобности нет: в AuthorIT это выполняется легким движением руки - путем добавления в структуру документа объекта glossary - 
- алфавитного указателя. Получается нечто, изображенное на рисунке ниже. Вроде ничего, зрительно не раздражает, а со стилями можно и поупражняться на досуге.
Возможно, это и есть тот самый информационно-поисковый аппарат или один из его элементов.
Вычитка документа, устранение ошибок в оформлении и опечаток
У автора обнаружилась только вычитка корректуры, а еще уандех указал на ГОСТ 7.62-2008 СИБИД. Знаки корректурные для разметки оригиналов и исправления корректурных и пробных оттисков. Общие требования.
Информация полезная, но как-то сомнительно, что выпускники нынешних СПТУ, именуемых колледжами, сколько-нибудь заточены на подобную деятельность. Возможно, имелось в виду умение пользоваться корректорами орфографии, встроенными в текстовые процессоры. Тогда да, но разве можно так фошыссски чудовищно и жестоко формулировать требования профессионального стандарта?
Что касается оформления (в широком смысле слова), то это уже ближе к задачам нормоконтроля и совсем иные квалификационные требования.
Необходимые умения
Быть может, лучше навыки или даже скиллы, но тут дело вкуса.
Работать в современном текстовом процессоре
Заголовок начинается с глагола. Наверное, «более по-русски» звучала бы фраза «Навыки работы в современном текстовом процессоре». Снова дело вкуса.
Что же такое современный текстовый процессор? Вероятно, соответствующий уровню развития техники. Взять, к примеру, Altova XMLSpy 2021 - современнейший и функциональнейший текстовый процессор, способный перекрыть возможности ВООБЩЕ ВСЕХ существующих в этом мире текстовых процессоров. С его помощью можно... Хотя достаточно упомянуть и о том, что ВООБЩЕ ВСЕ существующие современные текстовые процессоры так или иначе построены на основе XML.
Работать в Altova XMLSpy первое время несколько необычно, зато с ним можно творить настоящие чудеса.
Создавать, настраивать, применять стили в документе с помощью текстового процессора
Хорошо «бьется» с трудовым действием. Как бухгалтерская отчетность, до последней самой завалящей копеечки.
Только стили лучше не создавать, а применять готовые в минимально необходимом количестве. Автор довольно давно настроил себе пару шаблонов, один из которых удовлетворяет требованиям всех «оформительских» стандартов. А другой - гламурный, с буквицами, виньеточками и прочими картушами. Последний, в общем-то, и не в ходу.
Но важно другое - никогда не «сливать» стили чужих документов со своими, никогда сходу ничего из них не копипастить.
Чужой документ лучше открыть (после проверки антивирусным программным обеспечением), затем сразу же сохранить в формате HTML (чтобы не потерять нумерацию параграфов и списков), почистить HTML каким-нибудь редактором, например Dreamweaver или ему подобным, обязательно исправив при этом HTML-код Microsoft™ Word, как изображено на рисунке ниже.
После чего уже чистый HTML-файл следует открыть в Microsoft™ Word и применить к нему свой собственный шаблон. После такой обработки ничего уже никуда не расползется.
Создавать информационно-поисковый аппарат документа с помощью текстового процессора
Скилл (практический опыт) расписан в соответствующем «трудовом действии».
Необходимые знания
Есть несколько определений термина «знания» - такое, такое и такое.
Основные возможности современных текстовых процессоров
Современные текстовые процессоры отличаются от современных текстовых редакторов и редакторов строк тем, что умеют либо СОВСЕМ ВСЕ, что только можно себе вообразить, либо ПОЧТИ ВСЕ в части редактирования текста.
Основные стандарты оформления текстовых документов
Некоторые можно и перечислить:
- ГОСТ 2.105-95 Единая система конструкторской документации (ЕСКД). Общие требования к текстовым документам;
- ГОСТ 19.106-78 Единая система программной документации. Требования к программным документам, выполненным печатным способом;
- ГОСТ 7.32-2001 Система стандартов по информации, библиотечному и издательскому делу. Отчет о научно-исследовательской работе. Структура и правила оформления;
- и всякие прочие. Техническое задание на автоматизированную систему, к примеру, имеет свои собственные Правила оформления [из разд. 3 ГОСТ 34.602-89].
Основы типографики и полиграфической культуры
Автору известны только две культуры:
- Культура торгового обслуживания - Совокупность характеристик и условий процесса торгового обслуживания, определяемых профессионализмом и этикой обслуживающего персонала [из п. 131 ГОСТ Р 51303-2013].
- Организационная культура (Organizational culture) - Система восприятия, мышления и чувствования, осваиваемая совместно сотрудниками предприятия и передаваемая ими друг другу [из п. 2.25 ГОСТ Р 53894-2010].
Про полиграфическую не слыхал, про типографику тоже. Быть может, поможет вот эта сладкая парочка стандартов:
- ГОСТ Р ИСО/МЭК 2382-23-2004 Информационная технология. Словарь. Часть 23. Обработка текста.
- ГОСТ Р 7.0.3-2006 СИБИД. Издания. Основные элементы. Термины и определения.
Информационно-справочный и информационно-поисковый аппарат документа
Вот как все это знать? Вероятно, иметь представление о существовании:
- ГОСТ 7.73-96 Система стандартов по информации, библиотечному и издательскому делу. Поиск и распростарнение информации. Термины и определения;
- ГОСТ 7.74-96 Система стандартов по информации, библиотечному и издательскому делу. Информационно-поисковые языки. Термины и определения;
- и «рядом лежащих».
Инструменты: текстовые процессоры
...
Выводы по трудовой функции Оформление технического документа в соответствии с заданным стандартом (А/01.4)
Для себя автор осторожно решил, что, возможно, потянет на должность технического писателя-стажера, младшего технического писателя и даже оформителя технической документации. Но совсем не факт, что именно так и решит потенциальный работодатель, руководствующийся в своей деятельности профессиональным стандартом 06.019 Разработка технической документации и методического обеспечения продукции в сфере информационных технологий (ИТ). Разработка технической документации на продукцию в сфере ИТ, разработка технических документов информационно-методического и маркетингового назначения, управление технической информацией.
