ТехПисательство
ТехПисательство
Очередной раз заглянула на митап (https://www.youtube.com/watch?v=t2MYG7ewcbA) из чужой для меня области. Мне нужно изучить матчасть на тему того как правильно писать техническую документацию дя нашего продукта ForPeople (https://kas.pr/w5gb)
Вспомнила про структуру написания сочинения из средней школы)
Надо признаться, выступления просто отличные, очень творческие. Если вдруг вам зачем-то надо узнать про это, то рекомендую.
Некоторые #заметки по теме
Мария, руководитель группы пользовательской документации, Ozon
Страдания техписа:
• Документация никогда не будет идеальной
• Документация начинает устаревать в момент публикации
• Все нужно объяснять по десять раз
Что делать? Смириться)
• Документация не будет идеальной
• Никогда. Вообще. Совсем.
Причина страданий:
• Перфекционизм и многозадачность
• Непонимание процессов
• Невнимательность к коллегам и заказчикам
Решение:
• Планировать свою работу
• Проводить подробный ресерч
• Фиксировать правила и договоренности
Что еще полезно:
• Применять то, то фиксируете, на практике
• Расписывать процессы, рисовать схемы
• Уточнять насколько задача срочная
• Видеть полную картину
• Осознавать последствия своих действий
• Осознавать связь с другими участниками команды
Анна, техпис X5Tech
Путь:
1. Определиться с ЦА и ToV
2. Сформулировать цель документа
3. Составить структуру документа
4. Встретиться с экспертами
5. Погрузиться в сервис
6. Предугадать вопросы
7. Продумать страницу / раздел
8. Написать черновик
9. Провести ревью
10. Сохранить важную инфо
Александр, Gramax
Почему Docs as Code это хорошо?
• Удобное ревью благодаря Git-транзакциям
• Создание веток и их объединение
• CI / CD
• Статические сайты
• Асинхронное редактирование
Некоторые советы, кстати, очень подойдут создателям учебных курсов, мне кажется.
А я пойду читать наш docfx)
