documentation-and-adrs
A skill from Addy Osmani's agent-skills collection for recording why code is the way it is.
O que a skill ensina
A skill from Addy Osmani's agent-skills collection for recording why code is the way it is. When the agent makes an architectural decision, changes a public API or ships user-facing behaviour, it writes an architecture decision record, first matching any existing ADR folder, numbering and headings, and otherwise using the skill's template with context, decision, alternatives and consequences. It also covers when inline comments are worth adding and when not, API documentation through typed doc comments or OpenAPI, a README outline, keeping a changelog, documentation written for agents, and a final prose review.
O que faz
- Write architecture decision records matching existing conventions
- Document public APIs with doc comments or OpenAPI
- Outline a README and maintain a changelog
- Decide when inline comments are needed
Sobre
- Publicador
- Addy Osmani
- Ferramenta
- Documentation
Instalação
O projeto não documenta passos de instalação que tenhamos conseguido confirmar. Veja as instruções do próprio projeto
Servidores MCP e skills podem executar código no seu computador e agir sobre os seus dados. Revise o código-fonte antes de instalar.
Detalhes
| Fato | Valor | Fonte |
|---|---|---|
| Tipo | Skill | |
| Ferramenta | Documentation | |
| Publicador | Addy Osmani | fonte |
| Status oficial | Não informado na documentação | |
| Exige chave de API ou login | Não informado na documentação | |
| Inclui scripts | Não | fonte |
| Plataformas | Não informado na documentação | |
| Clientes de IA | Não informado na documentação | |
| Licença | MIT | fonte |
| Preço | Não informado na documentação | |
| Atividade | Último commit em 18 de nov. de 2026118.985 estrelas no GitHubDados de download indisponíveis (não está no npm nem no PyPI) | fonte |
| Links | Repositório Site |
Fontes
- Arquivo da skill (SKILL.md)github.com/addyosmani/agent-skills19 de nov. de 2026
- Arquivo de licença (LICENSE)github.com/addyosmani/agent-skills · Comprova: Licença12 de nov. de 2026
- Repositório no GitHubgithub.com/addyosmani/agent-skills · Comprova: Publicador, Atividade, Licença19 de nov. de 2026
- Pasta no repositório (documentation-and-adrs)github.com/addyosmani/agent-skills · Comprova: Inclui scripts19 de nov. de 2026