OpenSkillIndex← back to search
claude-code

Agent-skills-standard common-documentation

Write effective code comments, READMEs, and technical documentation following intent-first principles. Use when adding comments, writing docstrings, creating READMEs, or updating any documentation. (triggers: comment, docstring, readme, documentation)

install
source · Clone the upstream repo
git clone https://github.com/HoangNguyen0403/agent-skills-standard
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/HoangNguyen0403/agent-skills-standard "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/common/common-documentation" ~/.claude/skills/hoangnguyen0403-agent-skills-standard-common-documentation-1d5a9e && rm -rf "$T"
manifest: skills/common/common-documentation/SKILL.md
source content

Documentation Standards

Priority: P2 (MAINTENANCE)

1. Intent-First Comments

  • Explain "Why" logic exists. Avoid "What" mechanics.
  • Use triple-slash (Dart/Swift) or JSDoc (TS/JS) for public members.
  • Delete commented-out code. Use Git history.
  • Format: 
    TODO(username): description
    . Link tickets.

2. README Structure

  • Mission: Project purpose (one sentence).
  • Onboarding: Prerequisites, installation, usage (exact).
  • Maintenance: Document inputs/outputs, known quirks, fixes.
  • Sync: Documentation ships with feature.

3. ADRs & Architecture

  • ADRs: Document rationale for system changes in 
    docs/adr/
    .
  • Docstrings: Include Args, Returns, and Usage examples (
    >>>
    ).
  • Diagrams: Use Mermaid.js inside Markdown.

4. API Docs

  • Use Swagger/OpenAPI for REST.
  • Provide copy-pasteable examples for endpoints.
  • Define contract before implementation.

Anti-Patterns

  • No "what" comments: Explain intent. Refactor mechanics.
  • No orphan TODOs: Require owner and ticket.
  • No stale docs: Document during development.