46 подписчиков
Зачем техническим писателям создавать схемы и диаграммы
До того, как я устроился на работу техническим писателем, я думал, что схемы и диаграммы это что-то супер мудреное, непонятное и будто не особо нужное.
Оказалось, что это мудреное, непонятное, но очень даже нужное😁
Ну на самом деле сложности возникают только при построении первых 2-3 схем, а дальше уже становится гораздо легче.
Итак, зачем, например, нужна схема входящих данных в определённый сервис?
Наглядность. Схема наглядно покажет, откуда в сервис приходят данные, и что они из себя представляют.
Сортировка данных в голове. Отрисовав схему, мы будем четко знать, какие из этих данных вращаются только на бэкенде, а какие отображаются на UI. А это уже очень помогает при создании гайда.
Повышение понимабельности сервиса. Новым сотрудникам, которые только пришли в команду и пока вообще не понимают what the hell is going on схема поможет понять, что с чем взаимодействует, и сильно ускорит их погружение в общее дело.
Знакомство с разработчиками. Когда составляешь схемы различных сервисов, то постоянно взаимодействуешь с их разработчиками, и волей-неволей, начинаешь улавливать общие процессы. И каждая последующая задача уже дается чуть легче, а каждый следующий гайд получается все лучше.
1 минута
22 апреля 2023