skills.rest
deandum
deandumCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation

Write ADRs, READMEs, and inline comments to preserve design intent.

3|1|Updated Feb 10, 2026
Search Tags:#architecture#documentation#adr#readme#contract#code-comments
One-click install
npx skills add https://github.com/deandum/claude-resources --skill documentation-deandum
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/deandum/claude-resources/tree/main/skills/core/documentation
Command: npx skills add https://github.com/deandum/claude-resources --skill documentation-deandum

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation rot and unclear decisions erode project context; this skill helps you record design choices, ADRs, READMEs, and inline comments to preserve intent over time.

Core Features & Use Cases

  • Decision capture: write ADRs to document architectural choices and rationale.
  • Documentation norms: guide READMEs, onboarding steps, and API contracts to keep them stable.
  • Code-quality alignment: ensure comments justify why code exists and how it relates to decisions.

Quick Start

Document the latest architectural decision as an ADR, including context, decision, and consequences.

Frequently Asked Questions about documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write an ADR to document architectural decisions?▼

To write an ADR for architectural decisions, record the context, the decision itself, and the consequences. This preserves design intent and rationale, ensuring traceability and governance across the codebase over time.

What is the best way to prevent documentation rot in a codebase?▼

Preventing documentation rot requires keeping docs reliable by aligning READMEs, API contracts, and code comments with versioned decisions. Documenting the why behind code ensures context survives architectural changes.

How do I format inline comments to justify why code exists?▼

Formatting inline comments to justify why code exists involves linking the implementation back to architectural decisions. Comments should explain the design rationale and how the code relates to established project conventions.

Can I use this skill to document API contracts and onboarding steps?▼

Yes, you can use this skill to document API contracts and onboarding steps. It guides documentation norms for READMEs and contracts to keep them stable, supporting knowledge retention and project governance.

When do I need to record architectural decisions as ADRs?▼

You need to record architectural decisions as ADRs when a design choice impacts project context, traceability, or governance. Capturing the context, decision, and consequences preserves design intent against future documentation rot.

Related Skills

Explore More Content & Communication Skills→
gensart-projsgensart-projs

architecture

Document architectural decisions using structured ADR templates and checklists.

Community
Advanced
calcosmiccalcosmic
9

documentation-ingestion

Ingest and normalize project documentation into a structured colony knowledge base.

Community
Intermediate
JohannesKoningsJohannesKonings

grill-with-docs

Validate implementation plans against project domain models and documentation.

Community
Intermediate
klemensmsklemensms

markdown-docs

Standardizes Markdown docs with required frontmatter and a fixed section structure.

Community
Intermediate