✱ Подходы, инструменты, стандарты
Разговор с командой разработки на одном языке нотаций… Или как приручить лису
Techwriter Days #2
2025-03-28 10:00
Секция A
40 мин
Средне
Спикеры
Доклад был на прошедшей конференции Techwriter Days #2 и сейчас находится в архиве.
Мария Бурханова на Techwriter Days 2 рассказала, как общаться с командой разработки на одном языке нотаций и "приручить лису". Мария поделилась опытом работы техническим писателем, пришедшей в эту сферу с гуманитарным образованием. На конференции она объяснила, зачем важны нотации и как они помогают создавать эффективные текстовые инструкции.
Мария рассказала, что восприятие информации на лекциях и в работе улучшилось благодаря использованию схем и рисунков. Она подчеркнула, что графический материал позволяет быстрее и понятнее донести сложные концепции. На примерах диаграмм и блок-схем было показано, как из интуитивных изображений сделать структурированные и понятные инструкции.
Слушатели узнали о важности нотаций, таких как UML, BPMN, и как они облегчают понимание сложных систем. Мария объяснила, что выбор правильной нотации помогает не только в разработке документации, но и в разработке продукта в целом. Она поделилась, что важно видеть документацию как часть продукта, что помогает искать ответы в процессах разработки.
Доклад оказался полезным для тех, кто только начинает путь в технической документации, и для опытных специалистов, желающих улучшить свои навыки.
Критерии качества технической документации – полнота и точность. Последнее выполнить достаточно сложно – естественный язык не всегда однозначно воспринимается всеми участниками как разработки программного продукта, так и его пользователями. Иногда точности в документации можно достичь, используя именно графическую форму, например, схемы алгоритмов и диаграммы. А иногда, чтобы точно описать все функции и ограничения продукта для пользователей – важно подключаться как можно раньше и уметь разговаривать с аналитиком и разработчиком на одном языке моделей, методологий, методов и нотаций.
Но моделей и нотаций огромное количество. Во-первых, очень сложно разобраться в принципе во всех этих определениях. Во-вторых, не сразу понятно, зачем методов и нотаций так много, когда и какую нотацию используют аналитики и разработчики. И, наконец, как с этими графическими формами работать техническому писателю.
Моя цель – разложить всё по полочкам и систематизировать основные подходы.
Доступно только после покупки 😊
