Задать вопрос Поделиться знаниями Редактировать страницу
Обзорные статьи, helicopter view
Другие названия: bird’s view, обобщения, верхнеуровневое описание.
Наличие простых и ёмких материалов, объясняющих структуру системы, очень сильно помогает новичку быстро вникнуть в происходящее: войти в незнакомый проект, компанию, бизнес-домен или договариваться с коллегами из других подразделений.
Важно не только наличие документации как таковой, но и то, что в других документах или коммуникациях используются те же термины и те же фундаментальные подходы, что рассказываются в bird’s view.
Как составлять обзорные статьи быстро и просто? Задача выглядит чудовищно сложной, возможно есть какие-то проверенные подходы и способы собирать информацию, структурировать и достигать согласия со специалистами? |
Есть ли исследования на тему влияния обзорных статей на скорость онбординга, качество поддержки и т.п.? |
Как соблюсти баланс между краткостью, понятностью и полнотой? |