Frameworks e bibliotecas
- Onboarding o mais rápido possível
- Facilidade para fazer upgrade
- Mensagens de erro úteis
- Padrões e valores padrão fortes
- Permitir escapar das configurações padrão
- Redução de riscos por meio de dependências
Documentação
- Explicar com código (fornecer exemplos)
- Resolver problemas (responder perguntas)
- Gerar documentação automaticamente (manter atualizada a documentação de API etc.)
- Organizar também formas de resolver erros
- Otimizar para skimming (leitura rápida)
- Ser precisa (evitar jargões e expressões idiomáticas)
- Expor gradualmente as partes complexas
APIs
- Não quebrar o fluxo de trabalho da API (versionamento): como a Stripe
- Permitir testar a API rapidamente: a Square faz isso bem
1 comentários
"Otimizar para
skimming(leitura por alto)" é algo com que eu me identifico demais.