10.14489/hb.2025.06.pp.058-066

2025, 06 июнь (June)

DOI: 10.14489/hb.2025.06.pp.058-066

Тюлина Н. В.
ТЕХНОЛОГИЧЕСКИЕ СПОСОБЫ УЛУЧШЕНИЯ ТЕХНИЧЕСКОГО ДОКУМЕНТИРОВАНИЯ В ИТ-ОТРАСЛИ
(с. 58-66)

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

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

Tyulina N. V.
TECHNOLOGICAL WAYS IMPROVEMENT OF TECHNICAL DOCUMENTATION FOR IT INDUSTRY
(pp. 58-66)

Abstract. This article contains the roles and stages of the technological process of creating text technical documents for IT industry. The ways to combine the roles of author, editor, proofreader and quality control officer of text technical documents, also the strengths and weaknesses of such a combination are specified. A list of universal methods for editing, proofreading and quality control is proposed. Each method contains a description that allows anyone to use it immediately after reading it. These methods can be used for texts prepared by other specialists or independently. The advantages and disadvantages of these methods are given. The basic editorial, proofreading and quality control officer checks for text technical documents are listed. The possibility of automating most operations of editing and also some proofreading and quality control of text technical documents is indicated.

Keywords: Information technology; Text technical documents; Processes of text creation; Automation; Editing; Proofreading; Quality control.

+ - Информация об авторах (About the Authors) Click to collapse

Рус

Н. В. Тюлина (Общество с ограниченной ответственностью «Айти Прикладные Решения», Москва, Россия) E-mail: Данный адрес e-mail защищен от спам-ботов, Вам необходимо включить Javascript для его просмотра.

Eng

N. V. Tyulina (IT Applied Solutions LLC, Moscow, Russia) E-mail: Данный адрес e-mail защищен от спам-ботов, Вам необходимо включить Javascript для его просмотра.

+ - Библиографический список (References) Click to collapse

Рус

1. Тюлина Н. В. Количественный, качественный и организационный аспекты улучшения разработки технической документации // Качество и жизнь. 2023. № 3. С. 17–24.
2. Тулякова Е. И., Миляков А. И. Корректура. Часть 1. Томск: Изд-во Национальный исследовательский Томский государственный университет. 2014. 54 c.
3. Тихонова Ю. ChatGPT разочарует пользователей. Июль 2023. Электронный ресурс, дата обращения 14.05.2024. URL: https://www.comnews.ru/content/227772/2023-07-31/2023-w31/chatgpt-razocharuet-polzovateley.
4. ГОСТ 2.111–2013. Единая система конструкторской документации. Нормоконтроль: межгосударственный стандарт М.: Стандартинформ, 2013. 12 с.
5. Ахманов М. Литературный талант. Как написать бестселлер. М.: Эксмо, 2014. 378 с.
6. Рыжова Л. А. Корректура: учебное пособие для студентов учреждений сред. проф. образования, обучающихся по специальности 0206 «Изд. дело». М.: МИПК им. И. Федорова. 2005. 239 с.
7. Flaxman Stefanie. 10 Content Proofreading Tips to Catch More Avoidable Goofs (10 советов по корректуре, которые помогут выявить больше ошибок, которых можно избежать). Электронный ресурс, дата обращения 12.06.2024. URL: https://copyblogger.com/content-proofreading/.
8. Рябинина Н. З. Настольная книга редактора и корректора деловой литературы. М.: Международный центр финансово-экономического развития. 2004, 318 с.

Eng

1. Tyulina, N. V. (2023). Quantitative, qualitative and organizational aspects of improving the development of technical documentation. Kachestvo i zhizn', (3), 17–24. [in Russian language]
2. Tulyakova, E. I., & Milyakov, A. I. (2014). Proofreading. Part 1. Tomsk: Izdatel’stvo Natsional'nyy issledovatel'skiy Tomskiy gosudarstvennyy universitet. [in Russian language]
3. Tihonova, Yu. (2023). ChatGPT will disappoint users. Retrieved from https://www.comnews.ru/content/227772/2023-07-31/2023-w31/chatgpt-razocharuet-polzovateley. [in Russian language]
4. Unified system of design documentation. Norm control: interstate standard. (2013). Standard No. 2.111–2013. Moscow: Standartinform. [in Russian language]
5. Ahmanov, M. (2014). Literary Talent: How to Write a Bestseller. Msocow: Eksmo. [in Russian language]
6. Ryzhova, L. A. (2005). Proofreading: a teaching aid for students of secondary vocational education institutions studying in the specialty 0206 Publishing. Moscow: MIPK im. I. Fedorova. [in Russian language]
7. Flaxman Stefanie (2024). 10 Content Proofreading Tips to Catch More Avoidable Goofs. Retrieved from https://copyblogger.com/content-proofreading/.
8. Ryabinina, N. Z. (2004). A handbook for editors and proofreaders of business literature. Moscow: Mezhdunarodnyy tsentr finansovo-ekonomicheskogo razvitiya. [in Russian language]

+ - Заказать электронную версию статьи (Purchase digital version of a single article) Click to collapse

Рус

Статью можно приобрести в электронном виде (PDF формат).

DOI: 10.14489/hb.2025.06.pp.058-066

Скопируйте DOI статьи и перейдите по ссылке https://id-spektr.ru/product/pokupka-elektronnoy-stati-iz-zhurnala-spravochnik-inzhenernyy-zhurnal

В комментарии к заказу обязательно укажите DOI статьи.

Eng

This article is available in electronic format (PDF).

DOI: 10.14489/hb.2025.06.pp.058-066

Copy the article DOI and follow the link https://id-spektr.ru/product/pokupka-elektronnoy-stati-iz-zhurnala-spravochnik-inzhenernyy-zhurnal

Please specify the article DOI in the order comments.