agentleFS
Sign inStart free
viasrijanviasrijan/crazy-skills/skills/docs/documentation-and-adrs/SKILL.md

documentation-and-adrs

Skill0 starsChanged 3 months agoMITView on GitHub

Use when making architectural decisions, changing APIs, or shipping features — write Architecture Decision Records and API docs that capture the why.

68 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use constraint-driven-development, deprecation-and-migration and 5 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • MrCipherSmithSkill

    constraint-driven-development

    Use when a project needs a persistent, measurable quality bar — starting a project without documented standards, 'set up constraints', or when coverage/perf/a11y thresholds get re-debated per-PR. Produces CONSTRAINTS.md with enforceable numbers, ratchets, and a guard against silent weakening. NOT for throwaway prototypes or a one-off CI setup.

    Also in 15 projects that use this

  • HK-hubSkill

    deprecation-and-migration

    Manages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when deciding whether to maintain or sunset existing code.

    Also in 38 projects that use this

  • HK-hubSkill

    code-simplification

    Simplifies code for clarity. Use when refactoring code for clarity without changing behavior. Use when code works but is harder to read, maintain, or extend than it should be. Use when reviewing code that has accumulated unnecessary complexity.

    Also in 41 projects that use this

  • AnasX7Skill

    minimalist-ui

    Clean editorial-style interfaces. Warm monochrome palette, typographic contrast, flat bento grids, muted pastels. No gradients, no heavy shadows.

    Also in 3 projects that use this

  • VercelSkill

    web-design-guidelines

    Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".

    Also in 4 projects that use this

  • MicrosoftSkill

    playwright-cli

    Automate browser interactions, test web pages and work with Playwright tests.

    Also in 3 projects that use this

The file

Create a free account to mount
Files
SKILL.md

Documentation and ADRs

ADR and API docs. From addyosmani/agent-skills documentation-and-adrs.

When to use

  • Making an architectural decision or changing a public API
  • Shipping a feature that needs decision history

Workflow

  1. Capture decision — Write ADR to docs/adr/NNNN-<slug>.md (Number, Title, Context, Decision, Consequences, Alternatives). Keep one decision per ADR.
  2. API docs — If API changed, update docs/api/ with contract, error semantics, and boundary validation (Hyrum's Law, One-Version Rule).
  3. Link — Reference ADR from the PR and from docs/CATALOG.md if the decision affects skills.

Verification

  • ADR follows template (Context, Decision, Consequences, Alternatives)
  • API docs capture why, not just what
  • ADR linked from relevant PR/docs

References

  • Source: addyosmani/agent-skills documentation-and-adrs

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free