Арсенал инструментов для работы техписов – программное обеспечение (ПО), вполне себе привычное для современных IT-компаний. Рассмотрим плюс-минус стандартный набор.
ПО для работы с документами
1. Текстовый процессор. Как правило, это знакомый всем Microsoft Word. Но могут использоваться и какие-то другие решения для работы именно с файлами. Например, менее популярный «Мой офис» или даже облачный сервис «Яндекс.Документы».
2. Вики-система. Практически во всех компаниях, где я работала, в этом качестве использовался продукт Confluence. Один раз база знаний была развернута на собственном решении, на отдельном поддомене сайта компании.
А еще иногда вики-система частично заменяет текстовый редактор. Знаю компании, в которых в качестве технической и другой документации заказчикам передают выгрузки статей из Confluence. Естественно, чуть дооформленные в плане придания им более аккуратного вида (уже в текстовом редакторе).
3. Инструменты для создания веб-справок и онлайн инструкций. Большой выбор: от Dr.Explain до множества онлайн редакторов для использования Markdown. В теории подойдет любое программное обеспечение, поддерживающее язык разметки для текстовых документов.
4. Система управления версиями файлов. В этом качестве обычно используется Git. Или хранение файлов может быть организовано в облачном сервисе либо даже на базе других инструментов, перечисленных в этой статье. Например, в виде таблицы-реестра на странице в Confluence.
ПО для работы с продуктами
1. Сами программные продукты, для документирования которых был нанят техпис. Технические писатели описывают систему, развернутую на тестовом стенде, проде (продуктивном стенде) или препроде. Чаще всего в наличии больше одного ресурса.
2. Инструменты для интеграции и документирования API. Речь о Swagger, Postman и аналогах. Если на техписе есть задача документировать API (Application Programming Interface – программный интерфейс приложения), скорее всего, в арсенале его средств встретится что-то из этого.
ПО для работы с задачами и командой
1. Таск-трекер. Выполнение задач на написание и обновление документов большинство техписов отслеживают в Jira или Redmine. Но могут использоваться и решения в сфере импортозамещения: например, «Яга» или Yandex Tracker.
2. Сервис для проведения видеовстреч. Без созвонов в IT никуда. В каком месте соберется удаленная команда, каждый работодатель решает сам. Могут использоваться Zoom, TrueConf, VK Звонки, «МТС Линк Встречи». Первое место в топе я бы отдала отечественному решению «Яндекс Телемост». А вот Skype уже однозначно не в моде.
3. Решения для обмена текстовыми сообщениями и файлами. Объединю в одном пункте электронную почту и мессенджер. Официальный канал связи – всегда e-mail, и, как правило, корпоративный. Мессенджер – чаще всего Telegram. Но тут тоже могут использоваться какие-то корпоративные решения, например, YuChat.
А какие программные решения используете в работе вы?