{"actions":[{"alt":"Распознать","definition":"Разобраться в основных качествах продукта и, если это уместно, сравнить его с другими.","description":"Пользователи документации — это также потенциальные клиенты или те, кто может внедрить продукт. Читатель должен уметь распознать основные качества продукта и сравнить его с другими. Это процесс открытия.","examples":[{"title":"What is Databricks?","url":"https://docs.databricks.com/en/introduction/index.html"},{"title":"Splunk Observability Cloud Service Description","url":"https://docs.splunk.com/observability/en/get-started/service-description.html"}],"frameworks":{"diataxis":["Прямого аналога нет (ближайший — объяснение)"],"dita":["\u003ctopic\u003e","\u003cconcept\u003e"],"good_docs":["Обзор","Посадочная страница"]},"id":"appraise","metric":{"description":"Доля переходов от документации к внедрению продукта.","name":"конверсия"},"signals":["Служба поддержки и отдел продаж снова и снова отвечают на один и тот же вопрос: «Что это такое?»","Потенциальные клиенты узнают о назначении продукта из маркетинговых материалов, а не из документации.","Нет страницы, на которой сформулированы позиционирование и основные сильные стороны продукта."],"verb":"Оценить"},{"alt":"Открыть","definition":"Попробовать продукт и узнать о его возможностях при низком пороге входа.","description":"Отличные продукты приглашают пользователей взаимодействовать и пробовать новое. Документация должна предлагать подсказки, инструкции и возможности для действия, которые делают исследование одним из первых занятий.","examples":[{"title":"React Quick Start","url":"https://react.dev/learn"},{"title":"Tour of Go","url":"https://go.dev/tour/welcome/1"}],"frameworks":{"diataxis":["Учебное руководство"],"dita":["\u003ctask\u003e","\u003cstep\u003e","\u003csubstep\u003e"],"good_docs":["Учебное руководство"]},"id":"explore","metric":{"description":"Время от первого посещения до первого успешного взаимодействия.","name":"время до первой ценности"},"signals":["Новые пользователи не могут найти краткое руководство или песочницу, чтобы попробовать продукт.","При первом знакомстве пользователь видит стену справочных материалов, а не последовательный обзор.","Пользователю приходится прочитать всё руководство, прежде чем он сможет прикоснуться к продукту."],"verb":"Исследовать"},{"alt":"Припомнить","definition":"Восстановить в памяти сведения, которые невозможно было запомнить: от параметров до кодов ошибок.","description":"Благодаря справочным материалам документация сохраняет ценность спустя годы. Пользователи просматривают руководства, чтобы вспомнить, извлечь или найти сведения, которые они не смогли запомнить.","examples":[{"title":"Dockerfile reference","url":"https://docs.docker.com/reference/dockerfile/"},{"title":"GitLab CI/CD YAML syntax reference","url":"https://docs.gitlab.com/ee/ci/yaml/"}],"frameworks":{"diataxis":["Справочник"],"dita":["\u003creference\u003e","\u003crefsyn\u003e","\u003cproperties\u003e"],"good_docs":["Справочник","Глоссарий"]},"id":"remember","metric":{"description":"Доля обращений к справочнику, при которых пользователь получает нужную страницу.","name":"доля успешных поисков в справочнике"},"signals":["Пользователи ищут параметр или код ошибки и ничего не находят.","Справочные сведения разбросаны по публикациям в блогах и журналам чатов.","У продукта нет доступного для поиска структурированного справочника по синтаксису или настройкам."],"verb":"Вспомнить"},{"alt":"Решить","definition":"Быстро диагностировать и решать проблемы, часто в условиях давления.","description":"Проблемы из-за неверных настроек, пограничных случаев или настоящих ошибок — обычная часть пользовательского опыта. Устранение неполадок отражает потребность быстро диагностировать и решать проблемы, зачастую когда системы не работают или сроки поджимают.","examples":[{"title":"Kubernetes Debug Pods","url":"https://kubernetes.io/docs/tasks/debug/debug-application/debug-pods/"},{"title":"Elasticsearch Troubleshooting","url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-common-cluster-issues.html"}],"frameworks":{"diataxis":["Практическое руководство, ориентированное на проблему"],"dita":["\u003ctroubleshooting\u003e","\u003ctrouble\u003e","\u003ccause\u003e","\u003cremedy\u003e"],"good_docs":["Руководство по устранению неполадок"]},"id":"troubleshoot","metric":{"description":"Медианное время от появления симптома до восстановления рабочего состояния.","name":"время до решения"},"signals":["В обращениях в поддержку повторяется один и тот же вопрос, а ответ хранится в журнале чата, не в документации.","Сообщения об ошибках присутствуют в коде, но никогда не появляются в документации.","Пользователь ищет строку ошибки и попадает на страницу, где эта ошибка не упоминается."],"verb":"Устранить неполадки"},{"alt":"Интегрировать","definition":"Строить поверх продукта, расширять или интегрировать его, создавая дополнительную ценность.","description":"Пользователям часто нужно строить что-то поверх существующих продуктов, расширять или интегрировать их — с помощью интеграций, расширений, плагинов или совершенно новых приложений. Акцент почти всегда практический.","examples":[{"title":"Vercel Approval Checklist","url":"https://vercel.com/docs/integrations/create-integration/approval-checklist"},{"title":"Chrome Debug extensions","url":"https://developer.chrome.com/docs/extensions/get-started/tutorial/debug"}],"frameworks":{"diataxis":["Практическое руководство"],"dita":["\u003ctask\u003e","\u003ccodeblock\u003e","\u003ccoderef\u003e"],"good_docs":["Практическое руководство","Справочник API"]},"id":"develop","metric":{"description":"Число интеграций или расширений, созданных пользователями.","name":"рост экосистемы"},"signals":["Вопросы об интеграциях и расширениях остаются без ответа или отправляются на форум.","Нет руководства по созданию решений поверх продукта.","Точки расширения продукта не документированы."],"verb":"Разрабатывать"},{"alt":"Тренироваться","definition":"Научиться использовать продукт в обычной повседневной работе.","description":"Пользователям необходимо научиться работать с большинством частей продукта. Практика описывает потребность в процедурных знаниях — в понимании того, как использовать продукт в обычной повседневной работе.","examples":[{"title":"Generating a new SSH key (GitHub)","url":"https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent"},{"title":"Import contacts to MailChimp","url":"https://mailchimp.com/help/import-contacts-mailchimp/"}],"frameworks":{"diataxis":["Практическое руководство"],"dita":["\u003ctask\u003e","\u003cstep\u003e","\u003cchoicetable\u003e"],"good_docs":["Практическое руководство"]},"id":"practice","metric":{"description":"Доля пользователей, которые выполняют стандартную процедуру без обращения в поддержку.","name":"успешность задачи"},"signals":["Одни и те же практические вопросы повторяются в службе поддержки и сообществах.","Процедуры существуют только как неформальное знание команды или хранятся у кого-то в голове.","Нет пошагового руководства по распространённым административным задачам."],"verb":"Практиковаться"},{"alt":"Изучить","definition":"Осмыслить абстракции и ментальные модели, на которых построен продукт.","description":"Программные продукты строятся вокруг абстракций, которые трудно понять, хотя они принципиально важны для правильного использования. Концептуальная документация закрепляет знания наряду с исследованием и практикой.","examples":[{"title":"Kubernetes Concepts","url":"https://kubernetes.io/docs/concepts/overview/components/"},{"title":"Thinking in React","url":"https://react.dev/learn/thinking-in-react"}],"frameworks":{"diataxis":["Объяснение"],"dita":["\u003cconcept\u003e","\u003cglossentry\u003e","\u003csection\u003e"],"good_docs":["Концептуальное руководство","Глоссарий"]},"id":"understand","metric":{"description":"Доля основных абстракций, для которых существует отдельная концептуальная страница.","name":"охват понятий"},"signals":["Пользователи умеют работать с продуктом, но не могут объяснить, почему он устроен именно так.","Понятия объясняются только в комментариях к коду или во внутренних вики.","Нет глоссария или концептуального руководства по основным абстракциям продукта."],"verb":"Понять"}],"model":{"canonical":"https://passo.uno/seven-action-model/","description":"Описательная модель потребностей пользователей технической документации. Семь действий охватывают цели, которых читатель может хотеть достичь: оценить, понять, исследовать, практиковаться, вспомнить, разрабатывать и устранить неполадки.","license":"CC BY 4.0","source":"https://passo.uno/seven-action-model/index.md","title":"Модель документации на основе семи действий","version":"2025-01-09"}}