Skip to main content
✱ Подходы, инструменты, стандарты

Разговор с командой разработки на одном языке нотаций… Или как приручить лису

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

Другие доклады Techwriter Days #2