documentation-templates

documentation-templates is a cursor rule for Cursor from MN-Lizard-Team/aiyu-multi-agent. It costs 19 tokens per session (838 once invoked), scanned A, original, Apache-2.0.

Templates and structure guidelines for common software documentation, including READMEs, API references, code comments, and documentation designed to help AI understand a project.

In plain words
What is it for?
Use it to write a README, document API endpoints, explain configuration, organize architecture notes, or improve code comments.
Why use it?
It makes project information easier for developers and tools to find, understand, and use correctly.

Cursor rule for Cursor

Written for Cursor: installed under .cursor/. Also seen: mentions Cursor.

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is - [API Reference](./docs/api.md).

Good fit Use it to write a README, document API endpoints, explain configuration, organize architecture notes, or improve code comments.

Compare 6 cursor rules from other repositories ↓
Install

Getting it into your agent

It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.

Clone the repo
git clone --depth 1 https://github.com/MN-Lizard-Team/aiyu-multi-agent
agentmods
npx agentmods add rules/mn-lizard-team/aiyu-multi-agent/documentation-templates

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-templates

README.md
[![agentmods](https://agentmods.dev/badge/rules/mn-lizard-team/aiyu-multi-agent/documentation-templates.svg)](https://agentmods.dev/rules/mn-lizard-team/aiyu-multi-agent/documentation-templates)
Your own site
<a href="https://agentmods.dev/rules/mn-lizard-team/aiyu-multi-agent/documentation-templates"><img src="https://agentmods.dev/badge/rules/mn-lizard-team/aiyu-multi-agent/documentation-templates.svg" alt="Measured on agentmods" height="20"></a>
Per session 19 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 838 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00019 $0.00838
Opus 5 $0.00010 $0.00419
Sonnet 5 $0.00004 $0.00168
Haiku 4.5 $0.00002 $0.00084

Measured 4d ago against content hash 8bc93e37407d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, 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 4d ago.

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.

.cursor/rules/skills/documentation-templates.mdc · 198 lines

How it starts

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

Skill: documentation-templates

Cursor Agent-Requested Rule — applied when AI determines relevance.


Documentation Templates

Templates and structure guidelines for common documentation types.


1. README Structure

Essential Sections (Priority Order)

Section Purpose
Title + One-liner What is this?
Quick Start Running in <5 min
Features What can I do?
Configuration How to customize
API Reference Link to detailed docs
Contributing How to help
License Legal

README Template

# Project Name

Brief one-line description.

## Quick Start

[Minimum steps to run]

## Features

- Feature 1
- Feature 2

## Configuration

| Variable | Description | Default |
|----------|-------------|---------|
| PORT | Server port | 3000 |

## Documentation

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

## License

MIT

2. API Documentation Structure

Per-Endpoint Template

## GET /users/:id

Get a user by ID.

**Parameters:**
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |

**Response:**
- 200: User object
- 404: User not found

**Example:**
[Request and response example]

3. Code Comment Guidelines

JSDoc/TSDoc Template

/**
 * Brief description of what the function does.
 * 
 * @param paramName - Description of parameter
 * @returns Description of return value
 * @throws ErrorType - When this error occurs
 * 
 * @example
 * const result = functionName(input);
 */

When to Comment

✅ Comment ❌ Don't Comment
Why (business logic) What (obvious)
Complex algorithms Every line
Non-obvious behavior Self-explanatory code
API contracts Implementation details

4. Changelog Template (Keep a Changelog)

# Changelog

## [Unreleased]
### Added
- New feature

## [1.0.0] - 2025-01-01
### Added
- Initial release
### Changed
- Updated dependency
### Fixed
- Bug fix

Read the full file on GitHub · 198 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. 4d ago First seen · 198 lines · 19 tokens per session scan A 8bc93e37407d

Subscribe to this mod's changes

documentation-templates is a cursor rule published in the GitHub repository MN-Lizard-Team/aiyu-multi-agent (7 stars, last pushed 3mo ago), licensed Apache-2.0. It adds 19 tokens to every session and 838 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-09-03.