docs-and-adrs

Solid

Document decisions, not just code. Use when making architectural decisions, changing public APIs, shipping features, or capturing context for future engineers and agents.

AI & Automation 33 stars 0 forks Updated yesterday Apache-2.0

Install

View on GitHub

Quality Score: 83/100

Stars 20%
51
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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) Read `references/adrs.md` when making a significant architectural decision (framework/library choice, data model, auth strategy, API architecture, or any expensive-to-reverse choice) — it has the "When to Write an ADR" checklist, the ADR template, and the lifecycle states. ## Inline Documentation Read `references/inline-comments.md` when writing or reviewing inline code comments — it has the why-not-what rule with before/after examples and the gotcha-documentation pattern. ## API Documentation Read `references/api-documentation.md` when adding or changing a public API — it has the TypeScrip...

Details

Author
OutlineDriven
Repository
OutlineDriven/odin-claude-plugin
Created
8 months ago
Last Updated
yesterday
Language
Python
License
Apache-2.0

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category