Написание UI-текстов и создание контента для баз знаний
Описание ситуации
Разработка технической документации, написание UI-текстов и создание контента для корпоративных баз знаний, поддержание их в актуальном состоянии – это и есть основные обязанности технического писателя, суть его работы. В моем понимании это так.
Исполнение
- Помогал разработчикам программных продуктов, сайтов и презентаций:
- формулировал названия UI-элементов;
- составлял текстовые описания;
- отрисовывал графические схемы и процессы;
- обрабатывал изображения.
- Наполнял контентом и редактировал корпоративную базу знаний.
Особенности
Для отрисовки схем и процессов применял Draw.io ↗ и OmniGraffle ↗. Для обработки изображений – Adobe Photoshop ↗, Pixelmator Pro ↗ и TinyPNG ↗.
Корпоративную базу знаний мы вели в Google Workspace ↗. Документы хранились на G.Drive, редактировались в G.docs, G.sheets, G.Slides. Для заполнения таблиц применяли G.Forms, а навигацию по содержанию вынесли в закрытый G.Sites.
YouTrack ↗, Bitrix24 ↗, Yandex Wiki ↗ и Github Wikis ↗ у нас не прижились. Почему? Не знаю.