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

[jasiejames]

Много лет пользуюсь минималистичным редактором Q10.

[alexsavochkin]

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

[Surrogate]

Также можно использовать специализированные программы для написания технических документов, такие как Jupyter Notebook

Вот не думал, что Jupyter для этого!

[a1exjob]

Статья ни о чем :(

[Helgich]

Как и 90% статей на хабре. Все в пределах нормы.

[polar11beer]

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

[document_moscow]

да, я встречала и изучала этот момент. В рамках работы на компании мне не было необходимости с таким работать, но для себя я находила инструменты типа ClickHelp, Madcap flare и тд. На сколько мне известно, там как раз есть такой функционал - одновременной замены одинаковых частей в разных документах.

[myoffice_ru]

Здравствуйте! Жаль, что вы нас забыли упомянуть в статье. Приложения МойОфис для частных лиц доступны бесплатно (как для ПК, так и для смартфонов), скачать их можно с нашего сайта по ссылке: https://myoffice.ru/home/. Также наши редакторы интегрированы в облако Mail.ru — актуально тем, кто в поиске доступного варианта для работы в облаке.

[atshaman]

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

А так - ну будем мы в ворде маркдаун верстать и в гуглодоксах публиковать - и?

[Noospheratu]

И где хоть один пример инструмента в разделе 4?

"Существуют инструменты..." - это просто фраза. Примеры где?

Кроме того, смешаны в один раздел стили текста (документации) и стили оформления кода.

С кодом - более-менее всё понятно.

А вот со стилями MS Word, например - адский ад.

[Sagittarius67]

А вы точно технический писатель?

На сколько мне известно

[Ailpein]

довольно странно слышать в 2023 году, что надо пользоваться софтом ушедшей из России компании Microsoft - его тупо нельзя купить, зачем тогда советовать?

[yuraangelov]

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

[alexsavochkin]

Ага, а потом ГОСТ 19.106 в руки и вперёд. :) А ведь есть ещё более суровый ГОСТ 2.105, вот где жесть. И ведь оформление под каждый из них хорошо бы автоматизировать, но как там питон и луа помогут — вопрос вопросов.