agentleFS
Sign inStart free
juandelossantosjuandelossantos/another-agent-skills/skills/documentation-and-adrs/SKILL.md

documentation-and-adrs

Skill1 starsChanged 11 days agoMITView on GitHub

Document architectural decisions, API changes, and features. Use when something needs a written record. Do NOT use for code comments.

We split this skill into the rules it gives an agent

2 rules. 1 is common, 1 is distinctive, and 0 are very specific to this project.

  • 1

    Common

    Most of the 61 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Document decisions, not just code.

    line 16
  2. Common:

    No ADRs in a project with significant architectural choices

    line 74

“Common” is measured: kept by at least 6 in 10 of the 61 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Documentation and ADRs

Document decisions, not just code. The most valuable documentation captures the why.

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

When NOT to Use

  • Documenting obvious code or throwaway prototypes

Output Contract

Documentation artifacts — ADR markdown files (NNNN-title.md) with context, options, decision outcome, and consequences, inline documentation explaining the why (not the what), README with quick start and architecture overview, all files in docs/ or ADRs/ directory.

Core Workflows

Architecture Decision Records

→ See guides/ADR-GUIDE.md

ADR template, lifecycle, when to write them.

Inline Documentation

→ See guides/INLINE-DOCS.md

Comment the why, not the what.

README Structure

→ See guides/README.md

Quick start, commands, architecture overview.

Detailed Guides

GuideContent
guides/ADR-GUIDE.mdADR template, lifecycle, when to write
guides/INLINE-DOCS.mdComment principles, gotchas, API docs
guides/README.mdREADME template, changelog format

Quick Reference

ADR status: PROPOSED → ACCEPTED → (SUPERSEDED or DEPRECATED)

Comment the *why*, not the *what*.
Don't leave commented-out code.

Red Flags

  • Architectural decisions with no written rationale
  • Public APIs with no documentation
  • README that doesn't explain how to run
  • Commented-out code instead of deletion
  • No ADRs in a project with significant architectural choices

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.

Reviews can't be read right now.

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