Хабы: Блог компании Magnit Tech, Подготовка технической документации, Управление проектами, Управление разработкой, Управление продуктом
Везде, где мне доводилось работать, была одна и та же боль – документация. А если быть точнее, ее скупость или отсутствие как таковой. И на каждом новом месте мне приходилось быть тем, кто ее пишет.
Magnit Tech не стал исключением, ведь я пришла в команду, которую только-только сформировали. То есть – ни одной странички в Confluence в нашем разделе.
Звучит пугающе? А меня это заинтересовало. Так что, в этой статье я расскажу:
Зачем –> определение конечной цели
Кому –> распределение ответственности
О чем –> выбор темы для документации
Когда –> выбор времени для написания
Как –> эффективное донесение информации.
А также поделюсь двумя вариантами подхода к написанию документации + как работать над стилистическим оформлением.
Читать далее