Способы автоматизации процессов по написанию документации для технических писателей18.10.2023 01:01

6b993e610d45b658d41662dffd5bd996.jpg

Всем привет! Меня зовут Екатерина Мишинёва, я ведущий технический писатель с опытом работы в IT-компаниях более 10 лет.

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

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

  1. Сервисы с искусственным интеллектом;

  2. Облачные сервисы;

  3. Программы для создания и управления справочной документацией;

  4. Способы автоматизации использования стилей;

  5. Markdown-разметка;

  6. Макросы;

  7. Текстовые редакторы на любой вкус.

Ниже расскажу о том, что я нашла я и кратко пройдусь по каждому пункту .

1. Сервисы с искусственным интеллектом

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

  2. Hemingway App — это инструмент, который помогает улучшить читаемость и ясность текста. Он анализирует текст и предлагает советы по упрощению структуры и стиля.

  3. CopyAI — это платформа для создания контента с использованием искусственного интеллекта. Она позволяет создавать тексты, описания продуктов, рекламные объявления и многое другое.

  4. Jasper.ai — это генератор текстов на основе искусственного интеллекта, который может создавать статьи, описания продуктов и другие виды контента.

  5. Rytr.me — это еще один генератор текстов на основе ИИ, который может создавать различные виды контента, включая статьи, описания продуктов и рекламные объявления.

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

2. Облачные сервисы

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

  2. Microsoft Word Online — это веб-версия популярного текстового редактора Microsoft Word, доступная через браузер. Она предлагает большинство функций настольной версии, включая форматирование текста, стили, таблицы и графики.

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

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

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

  6. iCloud Pages — это текстовый редактор от Apple, доступный пользователям iCloud.

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

  1. HelpNDoc — программа для создания справочной документации с функциями управления контентом и пользователями.

  2. Doxygen — инструмент для генерации документации из комментариев исходного кода.

  3. Sphinx — система создания документации на основе reStructuredText и LaTeX.

  4. MkDocs — простой и быстрый генератор документации, основанный на Markdown.

  5. javadoc — инструмент для создания документации Java из комментариев в исходном коде.

  6. pydoc — встроенная в Python утилита для генерации документации.

  7. RoboHelp — программа для создания интерактивной справочной документации.

  8. Adobe Robotic — инструмент для автоматического создания и обновления документации.

  9. Microsoft Word — текстовый редактор, который можно использовать для создания справочной документации.

4. Способы автоматизации использования стилей

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

  1. Использование шаблонов: Создание и использование шаблонов с уже настроенными стилями и форматированием может помочь сэкономить время при создании новых документов.

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

  3. Интеграция с инструментами контроля версий: Интеграция инструментов контроля версий, таких как Git, с текстовыми редакторами, такими как Visual Studio Code, может обеспечить автоматическую проверку стиля и форматирования при коммите изменений.

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

  5. Использование плагинов и расширений: Многие текстовые редакторы имеют плагины и расширения, которые могут помочь с автоматизацией стилей. Например, в Visual Studio Code есть плагины для автоматического форматирования кода и другие функции, связанные со стилями.

5. Markdown-разметка

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

Один из способов изучения Markdown — использование онлайн-ресурсов, таких как сайты с уроками и руководствами. Также можно использовать специализированные программы для написания технических документов, такие как Jupyter Notebook или Google Docs, которые имеют встроенные функции для работы с Markdown.

Кроме того, существуют библиотеки для работы с Markdown на разных языках программирования, например, Python, Ruby и JavaScript. Эти библиотеки позволяют создавать более сложные документы с использованием Markdown, такие как электронные книги, блоги и т.д.

6. Макросы

Макросы VBA (Visual Basic для приложений) в Microsoft Word позволяют автоматизировать рутинные задачи, такие как форматирование стилей. Вот пример простого макроса VBA, который применяет стиль «Заголовок 1» к выделенному тексту: 

Sub ApplyHeading1Style() 
Selection.Style = "Заголовок 1" 
End Sub

Вы можете создать новый макрос в Word, открыв вкладку «Разработчик» (если она не отображается, включите панель инструментов разработчика в настройках Word), затем нажмите кнопку «Visual Basic» и вставьте код в модуль. После этого вы можете сохранить и запустить макрос, выбрав его из выпадающего меню кнопки «Макросы» на вкладке «Разработчик».

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

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

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

Sub AlignTablesAndPictures() 
Dim table As Table 
Dim pic As InlineShape 
Dim shpRect As ShapeRange 
Dim rng As Range 
Dim docActive As Document
Set docActive = ActiveDocument

For Each table In docActive.Tables
    With table
        .Range.ParagraphFormat.Alignment = wdAlignParagraphCenter
    End With
Next table

For Each pic In docActive.InlineShapes
    With pic.Range
        .ParagraphFormat.Alignment = wdAlignParagraphCenter
        .Font.Size = 11
    End With
Next pic
End Sub

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

7. Текстовые редакторы на любой вкус

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

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

  2. FocusWriter — программа блокирует все отвлекающие факторы, позволяя сосредоточиться на написании текста.

  3. Scrivener — программа помогает организовать и хранить все идеи и документы в одном месте.

  4. J — это текстовый редактор с возможностью настройки синтаксиса различных языков программирования и разметки.

  5. Sublime Text — мощный текстовый редактор с большим количеством функций и настроек.

  6. Atom — легкий текстовый редактор с поддержкой множества плагинов и тем оформления.

  7. Brackets — программа предназначена для веб-разработчиков, но также может использоваться техническими писателями.

В общем, выбор большой, а каждый для себя выберет сам, с чем и как ему работать.

Пишите в комментариях свои дополнения и мысли :)

© Habrahabr.ru