AGENT SKILL

documentation-templates

Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

License 许可
MIT
最近更新
2026-10-13
Stars
★ 0
Forks
0

01 前言 Front Matter

name
documentation-templates
description
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
allowed-tools
Read, Glob, Grep

03 SKILL.md 正文

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

5. Architecture Decision Record (ADR)

# ADR-001: [Title]

## Status
Accepted / Deprecated / Superseded

## Context
Why are we making this decision?

## Decision
What did we decide?

## Consequences
What are the trade-offs?

6. AI-Friendly Documentation (2025)

llms.txt Template

For AI crawlers and agents:

# Project Name
> One-line objective.

## Core Files
- [src/index.ts]: Main entry
- [src/api/]: API routes
- [docs/]: Documentation

## Key Concepts
- Concept 1: Brief explanation
- Concept 2: Brief explanation

MCP-Ready Documentation

For RAG indexing:

  • Clear H1-H3 hierarchy
  • JSON/YAML examples for data structures
  • Mermaid diagrams for flows
  • Self-contained sections

7. Structure Principles

Principle Why
Scannable Headers, lists, tables
Examples first Show, don't just tell
Progressive detail Simple → Complex
Up to date Outdated = misleading

Remember: Templates are starting points. Adapt to your project's needs.

04 同仓库更多 Skills

marnixGeerkens
marnixGeerkens/rocketlauncher-claude-code

zapier-make-patterns

No-code automation democratizes workflow building. Zapier and Make (formerly Integromat) let non-developers automate business processes without writing code. But no-code doesn't mean no-complexity - these platforms have their own patterns, pitfalls, and breaking points. This skill covers when to use which platform, how to build reliable automations, and when to graduate to code-based solutions. Key insight: Zapier optimizes for simplicity and integrations (7000+ apps), Make optimizes for power

★ 0
marnixGeerkens
marnixGeerkens/rocketlauncher-claude-code

yeet

Use only when the user explicitly asks to stage, commit, push, and open a GitHub pull request in one flow using the GitHub CLI (`gh`).

★ 0
marnixGeerkens
marnixGeerkens/rocketlauncher-claude-code

workflow-automation

Workflow automation is the infrastructure that makes AI agents reliable. Without durable execution, a network hiccup during a 10-step payment flow means lost money and angry customers. With it, workflows resume exactly where they left off. This skill covers the platforms (n8n, Temporal, Inngest) and patterns (sequential, parallel, orchestrator-worker) that turn brittle scripts into production-grade automation. Key insight: The platforms make different tradeoffs. n8n optimizes for accessibility

★ 0
marnixGeerkens
marnixGeerkens/rocketlauncher-claude-code

trigger-dev

Trigger.dev expert for background jobs, AI workflows, and reliable async execution with excellent developer experience and TypeScript-first design. Use when: trigger.dev, trigger dev, background task, ai background job, long running task.

★ 0
marnixGeerkens
marnixGeerkens/rocketlauncher-claude-code

slack-automation

Automate Slack workspace operations including messaging, search, channel management, and reaction workflows through Composio's Slack toolkit.

★ 0
marnixGeerkens
marnixGeerkens/rocketlauncher-claude-code

rote

Compile a proven agent skill (a SKILL.md plus references) into a deterministic pipeline that runs without an LLM in the loop, then serve it back to Claude as an MCP tool. Use when: rote, compile this skill, turn this skill into a workflow, make this skill deterministic, make this skill cheaper or faster, harden this skill for production, run this skill as a background job.

★ 0