Desenvolver Integrar
Construir sobre o produto, ampliá-lo ou integrá-lo para criar valor adicional.
Os utilizadores precisam frequentemente de construir sobre produtos existentes, ampliá-los ou integrá-los. Não se trata apenas de programar, mas de criar valor adicional sobre o produto principal, através de integrações, extensões, plugins ou aplicações inteiramente novas.
Exemplos de documentação que ajuda a desenvolver produtos são a Approval Checklist da Vercel e Debug extensions do Chrome. Note-se que o objetivo é quase sempre pragmático, e o tipo de conteúdo é, em grande medida, irrelevante. Muita documentação sobre integrações ou extensões assume a forma de guias ou até de artigos.
A documentação centrada nas necessidades de desenvolvimento ou integração cria uma ponte entre as capacidades atuais do produto e o seu potencial. Transforma os utilizadores em cocriadores e promove um ecossistema. Este tipo de documentação torna-se frequentemente a base de comunidades de prática.
O que o utilizador quer fazer
Os utilizadores precisam frequentemente de construir sobre produtos existentes, ampliá-los ou integrá-los, através de integrações, extensões, plugins ou aplicações totalmente novas. O objetivo é quase sempre pragmático.
Sinais de que a documentação não responde a esta necessidade
- As perguntas sobre integração e extensão ficam sem resposta ou são encaminhadas para um fórum.
- Não existe um guia para construir sobre o produto.
- Os pontos de extensão do produto não estão documentados.
Dois exemplos reais
Tipos de conteúdo comuns
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <task>, <codeblock>, <coderef> | Guia prático | Guia prático, Referência de API |
Uma métrica
crescimento do ecossistema · Número de integrações ou extensões criadas pelos utilizadores.