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