Документы и заказчик

Мы убрали с экрана два абзаца объяснений — и это улучшение

Всё написанное было правдой. Кроме одной фразы, которая разошлась с интерфейсом и врала месяцами, — и никто не заметил, потому что её не читали.

Александр Цапков10 сентября 20262 мин

На странице графа документов у нас стояло два абзаца: как работает физика раскладки, что делают слои, какой синтаксис у типов связей. Всё написанное было правдой. Мы это убрали.

Правило, из-за которого убрали

Объяснение «как это устроено» на экране — признак того, что интерфейс не объясняет себя сам.

Человек пришёл посмотреть на связи своих документов, а не читать про симуляцию сил. Знание о том, почему сделано именно так, нужно тому, кто правит код, — и жить оно должно там: в комментарии, в записи о решении, в документации.

Проверка одной фразой, если сомневаетесь: уберите этот текст — человек перестанет знать, что делать, или перестанет знать, как оно устроено внутри? Первое оставляем, второе снимаем.

Что осталось

Одна строка условных обозначений: какая линия что значит и что такое заготовка.

Легенда — не памятка. Без неё карта не читается: цвет линии несёт смысл, и угадать его нельзя. Разница именно в этом, а не в длине текста.

Мелочь, которая честнее любого рассказа о качестве

В убранном абзаце было написано: «зелёные линии — явные ссылки».

Линии на экране давно серые.

Объяснение разошлось с тем, что объясняло, и никто не заметил — ни мы, ни пользователи. Потому что его не читали. Текст, который никто не читает, не просто бесполезен: он незаметно врёт, и обнаруживается это только когда кто-то впервые в него всмотрится.

Куда это переехало

Объяснения не выброшены, а перенесены туда, где у них есть читатель:

ЧтоКуда переехало
почему раскладка устроена таккомментарий в коде
какое решение и с какой причинойзапись в docs/adr/
как этим пользоватьсяруководство на сайте

Пустое состояние экрана при этом отвечает на другой вопрос — не «как устроено», а «что здесь бывает и что сделать сейчас», и при необходимости даёт ссылку в справку одной строкой.

Как проверить у себя

Откройте свой продукт и найдите абзац, который никто не читает. Признаки: он объясняет устройство, а не действие; он стоит между человеком и его работой; он не менялся с тех пор, как его написали.

Дальше сверьте каждое утверждение в нём с тем, что на экране прямо сейчас.

Скорее всего, он тоже уже врёт.

Что из этого следует

Текст в интерфейсе стареет быстрее кода и не имеет проверки. Код ловят тесты, разметку — гейты, а фраза «зелёные линии» живёт ровно столько, сколько никто не удосужится посмотреть на линии.

Поэтому мы держим границу жёстко: экран называет, что здесь бывает и что сделать сейчас; он не объясняет, почему он устроен так. Не из аскетизма — из того, что второе некому проверять.


Граф связей у нас показывает, где решение принято, и делает это без абзаца объяснений рядом. Как устроены документы и связи — Документация и база знаний.

Документация и база знаний проектаВики проекта со ссылками между документами, графом связей и версией на каждую правку.

Автор

Александр ЦапковОснователь Скоупворк

Веду платформу и её боевой контур сам: разработка, выкат, дежурство. Пишу о том, на чём мы обожглись, — с датами, замерами и ссылками на решения в репозитории.