46 подписчиков
Разные направления технического писательства
Как и в любой сфере в техническом писательстве тоже есть свои направления. Я могу условно разделить их на четыре.
1. Пользовательские инструкции. Это User Manuals по типу такого. Такое направление есть как на русском, так и на английском языках. Сюда же можно отнести, например, создание инструкции по эксплуатации какого-нибудь бытового прибора, например, стиральной машинки.
На мой взгляд, это интересное и хорошее направление для старта в профессии, поскольку она призвана непосредственно помогать неопытным пользователям освоить тот или иной продукт/сервис.
2. Проектно-техническая документация. Сюда можно отнести спецификации, тех задания и тд., в том числе в узких специфических темах, например, в автомобилестроении. Для вакансий такого направления сразу указывается, что необходимо высшее техническое образование.
3. Создание описаний сервисов и поддержание актуальности баз данных.
Сюда можно отнести описание компонентов ПО, алгоритмов взаимодействия пользователя и сервиса, описание доступов пользователей к сервису, создание глоссариев и других справочных ресурсов и материалов. В общем, работа в сфере IT, но без необходимости знать кодинг.
Это занятие тоже не самое простое, но этому можно обучиться в процессе работы. Я на работе как раз занимаюсь подобными делами.
4. Создание баз знаний для облачных хостингов и справочников. Например, описание работы с RESTful API.
RESTful API — это интерфейс, используемый двумя компьютерными системами для безопасного обмена информацией через Интернет, т.е. стиль взаимодействия клиента и сервера. В общем, что-то на языке бэкенд разработки)
Для такой позиции необходимо общее понимание протоколов и инфраструктуры интернета и знание различного инструментария типа Kubernetes, и языков разметки типа Markdown или RST.
Лично я знаю, что все эти штуки существуют, но никогда их не использовал))
На мой взгляд это самый сложный вид тех писательства, тут уже не обойтись без знаний программирования.
1 минута
20 января 2023