documentation-standards

A set of rules for writing code comments, docstrings, documentation, and project files. It emphasizes explaining why code works, keeping documents easy to scan, and maintaining required project artifacts.

In plain words
What is it for?
Use it when adding comments or docstrings, updating project guidance, structuring prose, or reviewing documentation quality and line lengths.
Why use it?
It prevents missing explanations, unreadable long sections, and documentation changes that are difficult to review.

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/matrixfounder/agentic-development/documentation-standards
Any agent
npx skills add MatrixFounder/Agentic-development --skill documentation-standards
Clone the repo
git clone --depth 1 https://github.com/MatrixFounder/Agentic-development

Made for: Claude Code, Codex.

Per session 17 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 6,991 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.00017 $0.06991
Opus 5 $0.00009 $0.03495
Sonnet 5 $0.00003 $0.01398
Haiku 4.5 $0.00002 $0.00699

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

Security

Grade A, and why

documentation-standards 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 2d ago.

The scan reads SKILL.md. This mod also ships 5 executable files (assets/templates/jsdoc_template.ts, assets/templates/python_docstring.py, examples/good_documentation.py, …), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

.agent/skills/documentation-standards/SKILL.md · 477 lines

How it starts

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

Documentation Standards

Purpose: Defines the non-negotiable standards for code comments, docstrings, and global artifacts.

1. Red Flags (Anti-Rationalization)

STOP if you are thinking:

  • "I'll add comments later" -> WRONG. Undocumented code is technical debt from the moment it is written.
  • "The code is self-documenting" -> WRONG. Code explains how; comments explain why.
  • "Artifacts are optional, I can skip them entirely" -> WRONG. Artifacts are part of delivery quality; .AGENTS.md must follow project memory policy.
  • "I'll put the full explanation in the table cell" -> WRONG. A table is a scanning device. Prose inside a cell destroys scanning and makes every row of that table churn on any edit. Cell = label; explanation goes below the table.
  • "It's all one topic, so it's one paragraph" -> WRONG. Topic is not structure. A reader needs entry points: paragraphs, lists, headings. A 30-line block has none.
  • "Line length doesn't matter, editors soft-wrap" -> WRONG. git diff and review comments are line-granular. A 2000-character line means a one-word fix shows up as a whole-paragraph rewrite, and reviewers stop reading.

2. Docstrings & JSDoc

All classes and functions MUST have documentation.

Python

Use Google-style docstrings.

[!TIP] See assets/templates/python_docstring.py for the format.

JavaScript / TypeScript

Use JSDoc standards.

[!TIP] See assets/templates/jsdoc_template.ts for the format.

3. Comments

  • Why vs What: Explain the reason for logic, not the syntax.
  • Work Tracking: Use # T O D O: (Python) or // T O D O: (JS/TS) for future work.

4. Path & Reference Standards (CRITICAL)

  • Relative Paths Only: When linking to internal files in Artifacts (PLAN.md, TASK.md), ALWAYS use relative paths.
    • [Ref](src/main.py)
    • [.agent/skills/core.md](.agent/skills/core.md)
    • file:///Users/username/project/src/main.py
    • /Absolute/System/Path

Read the full file on GitHub · 477 lines

Files

What ships with it

6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 2d ago First seen · 477 lines · 17 tokens per session scan A 2ec1ea8be47d

Subscribe to this mod's changes

documentation-standards is a skill published in the GitHub repository MatrixFounder/Agentic-development (5 stars, last pushed 19d ago), licensed Apache-2.0. It adds 17 tokens to every session and 6,991 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.

Related

Other skills, from other repositories

argent-tv-interact

Control and inspect TV apps via argent — Apple TV (tvOS), Android TV (leanback), and Amazon Fire TV (Vega). Boot the target, read focus, navigate with the D-pad remote, type, screenshot, and on Vega debug the JS runtime (evaluate, console logs, network inspector). Use when a task targets a TV (runtimeKind "tv", or…

software-mansion/argent · 107 tokens

review-offered-task

Review a task that has been offered to you and decide whether to accept or reject it.

desplega-ai/agent-swarm · 22 tokens

company-hiring-intelligence

Reverse-engineer what a company is building by scraping their job postings, careers page, LinkedIn Jobs, and engineering blog using TinyFish web agents. Use whenever a user wants to understand a company's strategic direction from hiring signals, do competitive intelligence, figure out a tech stack from job…

tinyfish-io/tinyfish-cookbook · 169 tokens

文档协作

引导用户通过结构化的文档共同编写工作流程。当用户想撰写文档、提案、技术规范、决策文档或类似结构化内容时使用。该工作流程帮助用户高效传递上下文,通过迭代优化内容,并验证文档对读者有效。当用户提到写文档、创建提案、起草规范或类似文档任务时触发。.

Tencent/WeKnora · 95 tokens

aidd-dev:08:for-sure

Iterative agent loop that tracks attempts and retries until a success condition is met. Use when the user says "for sure", "make sure", "keep trying until", "loop until done", "don't stop until", or needs guaranteed completion of a task with explicit success criteria.

ai-driven-dev/framework · 66 tokens

Swift Performance Optimization Skill

Use when investigating measured Swift or Apple-platform regressions in CPU, memory, launch, scrolling, animation hitches, image processing, energy, networking, or concurrency, or when designing performance tests and Instruments experiments. Do not use for speculative micro-optimization, ordinary refactoring, or a…

termio-sh/termio · 68 tokens