addyosmani avatar

Documentation And Adrs

This one keeps you from re-litigating the same architectural decisions every six months. It pushes you to write ADRs when choosing databases, frameworks, or API patterns, with a solid template that captures context, alternatives considered, and consequences. The inline documentation guidance is spot on: comment the why, not the what, and document gotchas that will bite future engineers or agents. Includes practical templates for API docs, READMEs, and changelogs. The "common rationalizations" section cuts through the usual excuses about self-documenting code. Most valuable for teams that keep rebuilding context from scratch because nobody wrote down why they picked PostgreSQL over MongoDB.

skills.sh installs
73.5K
GitHub stars
114.6K
last updated
Aug 21, 2026

Install

$ npx -y skills add addyosmani/agent-skills --skill documentation-and-adrs --agent claude-code

Installs into .claude/skills of the current project.

Files

Documentation and ADRs

Overview

Document decisions, not just code. The most valuable documentation captures the why — the context, constraints, and trade-offs that led to a decision. Code shows what was built; documentation explains why it was built this way and what alternatives were considered. This context is essential for future humans and agents working in the codebase.

When to Use

  • Making a significant architectural decision
  • Choosing between competing approaches
  • Adding or changing a public API
  • Shipping a feature that changes user-facing behavior
  • Onboarding new team members (or agents) to the project
  • When you find yourself explaining the same thing repeatedly

When NOT to use: Don't document obvious code. Don't add comments that restate what the code already says. Don't write docs for throwaway prototypes.

Architecture Decision Records (ADRs)

ADRs capture the reasoning behind significant technical decisions. They're the highest-value documentation you can write.

When to Write an ADR

Sponsors

Details

Repository
github.com/addyosmani/agent-skills
Categories
Documentation, AI & Agent Building
First seen
Apr 16, 2026

More from addyosmani/agent-skills

All 25
1googleworkspace avatarrecipe-draft-email-from-docgoogleworkspace/cliRead content from a Google Doc and use it as the body of a Gmail message.32.3Kskills.sh installs
2github avatardocumentation-writergithub/awesome-copilotDiátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure o28.4Kskills.sh installs
3github avatarcreate-readmegithub/awesome-copilotCreate a README.md file for the project19.5Kskills.sh installs
4backnotprop avatarplannotator-visual-explainerbacknotprop/plannotatorGenerate self-contained HTML visualizations with Plannotator theming. Use for implementation plans, PR explainers, architecture diagrams, data tables, slide dec13.9Kskills.sh installs
5tw93 avatarlearntw93/wazaRuns a six-phase research workflow that turns unfamiliar domains, source bundles, or collected material into publish-ready output. Use when users ask in any lan13.5Kskills.sh installs
6github avatarcomment-code-generate-a-tutorialgithub/awesome-copilotTransform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete 8.9Kskills.sh installs