documentation

Standards for documenting code and maintaining README and API documentation. API documentation explains how software endpoints accept requests and return responses.

In plain words
What is it for?
Use it when adding docstrings, updating README files, changing API routes or data formats, or documenting requests, responses, and errors.
Why use it?
It keeps explanations, setup instructions, environment-variable requirements, and API details current as the code changes. This makes the project easier to run, understand, and integrate with.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/aps08/fullstack-clean-architecture/documentation
Any agent
npx skills add aps08/fullstack-clean-architecture --skill documentation
Clone the repo
git clone --depth 1 https://github.com/aps08/fullstack-clean-architecture

Made for: Claude Code, Codex.

Per session 16 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 696 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00016 $0.00696
Opus 5 $0.00008 $0.00348
Sonnet 5 $0.00003 $0.00139
Haiku 4.5 $0.00002 $0.00070

Measured yesterday against content hash a8a1f11851bd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.agents/skills/documentation/SKILL.md · 46 lines

How it starts

The opening of the file, as written. The whole thing — 46 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Skill

Code Documentation

  • Add professional, clear docstrings to all major classes and functions.
  • Explain the "Why" and not just the "What".

READMEs

  • Maintain up-to-date README files in both the server and web directories detailing how to run the development servers and tests.
  • Document any environment variable requirements clearly.

API Documentation (docs/API_FLOW.md)

You must update docs/API_FLOW.md if anything changes in the API (e.g., creating new routes, updating existing endpoints, or changing schemas/parameters). The updates must follow the exact format given in docs/API_FLOW.md:

  • Heading: Must say # API Document and Flow Diagram.
  • Index: Must contain a clickable index of all the created APIs pointing to the corresponding details blocks.
  • API Details Structure: Use HTML <details> and <summary> tags to format each API as an accordion:
    • Inside the main <details> block, include a markdown table summarizing:
      • URL
      • Method
      • Auth Required
      • Description
    • Nest three separate <details> blocks under a blockquote (>) for the Request, Response, and Error JSON bodies:
      • Request body (or query/payload details) listing each field, its data type, Required or Optional status, alternative alias/name accepted (e.g. snake_case names for camelCase parameters if supported by the backend model configuration), description, and an example JSON payload.
      • Response body containing the successful response JSON schema/example.
      • Error body containing potential error JSON structures (e.g., 401, 404, 422, 429) and when they will arrive.
    • Nest another <details> block containing a colorful, sequential mermaid flowchart showing the numbered request flow (e.g., 1. POST ->, 2. Validate ->, 3. INSERT ->, etc.) without circular paths.

Database Design Documentation (docs/DATABASE_DESIGN.md)

You must update docs/DATABASE_DESIGN.md if anything changes in the server/app/models folder (e.g., adding/modifying SQLAlchemy models, tables, columns, or relationships). The updates must follow the exact format given in docs/DATABASE_DESIGN.md:

Read the full file on GitHub · 46 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 46 lines · 16 tokens per session scan A a8a1f11851bd

Subscribe to this mod's changes

documentation is a skill published in the GitHub repository aps08/fullstack-clean-architecture (2 stars, last pushed 3mo ago), licensed Apache-2.0. It adds 16 tokens to every session and 696 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.