Модель документации на основе семи действий
Модель того, что читателям нужно от документации, а не того, какой контент следует писать.
Семь действий
Описательная модель потребностей пользователей технической документации. Семь действий охватывают цели, которых читатель может хотеть достичь: оценить, понять, исследовать, практиковаться, вспомнить, разрабатывать и устранить неполадки.
- Оценить Распознать
- Разобраться в основных качествах продукта и, если это уместно, сравнить его с другими.
- Понять Изучить
- Осмыслить абстракции и ментальные модели, на которых построен продукт.
- Исследовать Открыть
- Попробовать продукт и узнать о его возможностях при низком пороге входа.
- Практиковаться Тренироваться
- Научиться использовать продукт в обычной повседневной работе.
- Вспомнить Припомнить
- Восстановить в памяти сведения, которые невозможно было запомнить: от параметров до кодов ошибок.
- Разрабатывать Интегрировать
- Строить поверх продукта, расширять или интегрировать его, создавая дополнительную ценность.
- Устранить неполадки Решить
- Быстро диагностировать и решать проблемы, часто в условиях давления.
Для агентов
- Введение — Зачем нужна модель документации на основе семи действий.
- Глоссарий — Все термины модели: семь действий, их альтернативные глаголы и значение каждого из них.
- Skill модели документации на основе семи действий — Установите агентский skill для планирования и улучшения документации с помощью модели на основе семи действий.
- Версии в Markdown — Каждая страница также доступна как index.md.
- model.json — Машиночитаемая модель
- llms.txt — Указатель сайта для языковых моделей
- sitemap.md — Карта сайта
- AGENTS.md — Как агентам читать этот сайт
Модель документации на основе семи действий · 2025-01-09 · CC BY 4.0 · Введение · Fabrizio Ferri Benedetti