documentation-templates

A set of starting templates and writing guidelines for common project documents. It covers files such as READMEs, API references, code comments, changelogs, decision records, and agent-readable configuration.

In plain words
What is it for?
Use it when documenting a new project, describing API endpoints, recording technical decisions, updating a changelog, or preparing files for both developers and coding agents.
Why use it?
It removes the uncertainty of what information belongs in each document and gives developers a consistent structure to adapt.

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/phuonghx/aim-cli/documentation-templates
Any agent
npx skills add phuonghx/aim-cli --skill documentation-templates
Clone the repo
git clone --depth 1 https://github.com/phuonghx/aim-cli

Made for: Claude Code, Codex.

Per session 82 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 972 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.00082 $0.00972
Opus 5 $0.00041 $0.00486
Sonnet 5 $0.00016 $0.00194
Haiku 4.5 $0.00008 $0.00097

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

Security

Grade A, and why

documentation-templates 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.

aim/templates/aim-agents/skills/documentation-templates/SKILL.md · 183 lines

How it starts

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

Documentation Templates

The layouts below are scaffolds. Drop in your project's specifics and prune whatever doesn't apply — a template that survives untouched usually means it wasn't read.

The README

Sections, in the order readers want them

A reader scanning a new repo asks a predictable sequence of questions. Order the sections to answer them in that order:

Section The question it answers
Name + tagline What even is this?
Quick start How do I run it in five minutes?
Features What can it actually do?
Configuration How do I tune it?
API reference Where are the details?
Contributing How do I pitch in?
License What am I allowed to do?

Skeleton

# ProjectName

One sentence on what it does.

## Quick Start

[The fewest steps to a running instance]

## Features

- Does X
- Does Y

## Configuration

| Variable | Meaning | Default |
|----------|---------|---------|
| PORT     | Listen port | 8080 |

## Docs

- [API reference](./docs/api.md)
- [Architecture](./docs/architecture.md)

## License

Apache-2.0

API Reference

One block per endpoint

## GET /orders/:id

Fetch a single order.

**Path params**
| Name | Type | Required | Meaning |
|------|------|----------|---------|
| id   | string | yes | Order identifier |

**Responses**
- 200 — the order object
- 404 — no order with that id

**Example**
[A real request and its response]

Doc Comments

The JSDoc / TSDoc shape

/**
 * One line on what this does.
 *
 * @param amount - The charge in cents
 * @returns The created receipt
 * @throws PaymentError - if the card is declined
 *
 * @example
 * const receipt = charge(1999);
 */

Comment the why, skip the what

Worth a comment Skip it
The reason behind a rule Restating the code
A tricky algorithm Line-by-line narration
Surprising behavior Code that reads plainly
The contract a caller relies on Internal mechanics

Read the full file on GitHub · 183 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 · 183 lines · 82 tokens per session scan A 04c4f3e7e4e5

Subscribe to this mod's changes

documentation-templates is a skill published in the GitHub repository phuonghx/aim-cli (1 stars, last pushed 2mo ago), licensed MIT. It adds 82 tokens to every session and 972 once invoked, about $0.0004 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

hs-release

Cut a core Hindsight release (vX.Y.Z) and open the changelog + blog PR. Use when asked to cut/start a release, bump the version, or publish a new Hindsight version.

vectorize-io/hindsight · 45 tokens

hindsight-local

Store user preferences, learnings from tasks, and procedure outcomes. Use to remember what works and recall context before new tasks. (user).

vectorize-io/hindsight · 32 tokens

research-repository

Build a repository that makes findings findable, reusable, and cumulative across teams. Use when the same research keeps getting redone. For synthesising one study, use affinity-diagram.

Owl-Listener/designer-skills · 43 tokens

design-negotiation

Advocate for design quality, scope, and timeline with partners and leadership using evidence and shared goals. Use in the conversation itself. For the commercial vocabulary behind it, use business-design (ux-strategy).

Owl-Listener/designer-skills · 48 tokens

user-persona

Build research-grounded personas with goals, frustrations, and behavioural patterns. Use when decisions need a consistent user reference. For one session's emotional snapshot use empathy-map; for motivation framing use jobs-to-be-done.

Owl-Listener/designer-skills · 50 tokens

version-control-strategy

Define version control for design files, components, and libraries — branching, naming, and release. Use when file history is chaotic. For design system contribution rules, use design-system-governance (design-systems).

Owl-Listener/designer-skills · 50 tokens