С ростом меняется сама задача
Небольшой набор документации способен пережить почти любую навигацию. Когда страниц двадцать, читатель может просмотреть меню, авторы помнят, где что лежит, а дубли ещё заметны. На пятистах страницах эти преимущества исчезают. Структура становится самостоятельной функцией продукта.
Первое правило — не считать дерево каталогов информационной архитектурой. Структура репозитория нужна тем, кто поддерживает исходники; навигация нужна читателю. Иногда они совпадают, но решают разные задачи.
Начните с намерений пользователя и типов контента
Перечислите причины, по которым человек открывает документацию: понять концепцию, выполнить задачу, найти значение поля, устранить ошибку, разобраться в изменении версии. Затем определите небольшой набор типов материалов, которые обслуживают эти сценарии.
Контент-модель задаёт для каждого типа предсказуемые метаданные и структуру. Чем больше архив, тем ценнее эта последовательность: она позволяет строить фильтры, фасеты поиска, автоматические проверки и повторно используемые шаблоны.
Верхний уровень должен быть скучным
Глобальное меню должно меняться редко. Не добавляйте туда новый пункт каждый раз, когда появляется важная технология, продуктовая команда или модная тема. Быстро меняющиеся детали держите ниже и выводите через теги, подборки и поиск.
Простой тест: если категория может исчезнуть при следующей реорганизации компании, ей, вероятно, не место в постоянной навигации.
Проектируйте связи, а не только дерево
Читатели редко идут по документации как по учебнику. Они приходят из поиска, задач, кода, ответов поддержки и старых закладок. Поэтому каждая страница должна иметь достаточно контекста и вести к следующему вероятному действию.
Связывайте концепции с процедурами, процедуры — со справочником, ошибки — с инструкциями по восстановлению. Избегайте огромных блоков «Смотрите также», которые просто показывают таксономию.
Проверяйте архитектуру до того, как она начнёт мешать
Ищите изолированные страницы, одинаковые заголовки, битые ссылки, разделы с сотнями дочерних материалов и теги-дубликаты. Анализируйте поисковые запросы, на которые сайт отвечает плохо. Периодически проходите навигацию как новый читатель.
Информационная архитектура — не схема, нарисованная один раз. Это постоянная работа по обслуживанию системы, которая должна принять следующие пятьсот страниц, не сделав первые пятьсот менее доступными.
Практический разбор
Чтобы превратить идеи статьи «Информационная архитектура документации, которая продолжает расти» в рабочую практику, возьмите один материал, который действительно меняется на этой неделе: процедуру, страницу релиза, onboarding, troubleshooting или запись об ответственности. До редактирования зафиксируйте четыре вещи: кто читатель, какое событие заставляет материал меняться, кто может проверить факты и что читатель должен уметь сделать после чтения. Такой короткий разбор быстрее обнаруживает скрытые предположения, чем абстрактная задача «улучшить документацию».
Проведите через процесс одно реальное изменение от начала до конца. Не перестраивайте систему целиком: измените один факт, один шаг или одну ответственность и посмотрите, где теряется информация. Проверьте:
- понятен ли ожидаемый результат без вопроса автору;
- есть ли владелец следующего обновления;
- может ли рецензент проверить изменённый факт по продукту или процессу;
- останется ли страница понятной после удаления устаревшего скриншота или обходного решения.
Метод становится надёжным не тогда, когда красиво выглядит на статичном примере, а когда переживает настоящее изменение.
Короткий редакционный чек-лист
- С ростом меняется сама задача. Небольшой набор документации способен пережить почти любую навигацию.
- Начните с намерений пользователя и типов контента. Перечислите причины, по которым человек открывает документацию: понять концепцию, выполнить задачу, найти значение поля, устранить ошибку, разобраться в изменении версии.
- Верхний уровень должен быть скучным. Глобальное меню должно меняться редко.
- Проектируйте связи, а не только дерево. Читатели редко идут по документации как по учебнику.
