Разрабатывать Интегрировать
Строить поверх продукта, расширять или интегрировать его, создавая дополнительную ценность.
Пользователям часто нужно строить что-то поверх существующих продуктов, расширять их или интегрировать с другими системами. Речь не только о программировании, но и о создании дополнительной ценности на основе основного продукта — с помощью интеграций, расширений, плагинов или совершенно новых приложений.
Примеры документации, которая помогает развивать продукт дальше: Vercel Approval Checklist и руководство Chrome Debug extensions. Обратите внимание: акцент почти всегда делается на практике, а тип контента в значительной степени неважен. Многие материалы об интеграциях и расширениях оформлены как руководства или даже статьи.
Документация, ориентированная на разработку или интеграцию, становится мостом между текущими возможностями продукта и его потенциалом. Она превращает пользователей в соавторов и способствует появлению экосистемы. Такой тип документации часто становится основой профессиональных сообществ.
Что пользователь хочет сделать
Пользователям часто нужно строить что-то поверх существующих продуктов, расширять или интегрировать их — с помощью интеграций, расширений, плагинов или совершенно новых приложений. Акцент почти всегда практический.
Признаки того, что документация этого не обеспечивает
- Вопросы об интеграциях и расширениях остаются без ответа или отправляются на форум.
- Нет руководства по созданию решений поверх продукта.
- Точки расширения продукта не документированы.
Два примера из практики
Распространённые типы контента
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <task>, <codeblock>, <coderef> | Практическое руководство | Практическое руководство, Справочник API |
Одна метрика
рост экосистемы · Число интеграций или расширений, созданных пользователями.