Loading...
Loading...
Templates and structure guidelines for common documentation types.
| 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 |
# 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
## 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]
/**
* 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);
*/
| ✅ Comment | ❌ Don't Comment | |-----------|-----------------| | Why (business logic) | What (obvious) | | Complex algorithms | Every line | | Non-obvious behavior | Self-explanatory code | | API contracts | Implementation details |
# Changelog
## [Unreleased]
### Added
- New feature
## [1.0.0] - 2025-01-01
### Added
- Initial release
### Changed
- Updated dependency
### Fixed
- Bug fix
# 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?
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
For RAG indexing:
| 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.
documentation-templates is an expert AI persona designed to improve your coding workflow. Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation. It provides senior-level context directly within your IDE.
To install the documentation-templates skill, download the package, extract the files to your project's .cursor/skills directory, and type @documentation-templates in your editor chat to activate the expert instructions.
Yes, the documentation-templates AI persona is completely free to download and integrate into compatible Agentic IDEs like Cursor, Windsurf, Github Copilot, and Anthropic MCP servers.
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
Download Skill Package.cursor/skills@documentation-templates in editor chat.Copy the instructions from the panel on the left and paste them into your custom instructions setting.
"Adding this documentation-templates persona to my Cursor workspace completely changed the quality of code my AI generates. Saves me hours every week."
Developers who downloaded documentation-templates also use these elite AI personas.
Expert in building 3D experiences for the web - Three.js, React Three Fiber, Spline, WebGL, and interactive 3D scenes. Covers product configurators, 3D portfolios, immersive websites, and bringing depth to web experiences. Use when: 3D website, three.js, WebGL, react three fiber, 3D experience.
Structured guide for setting up A/B tests with mandatory gates for hypothesis, metrics, and execution readiness.
You are an accessibility expert specializing in WCAG compliance, inclusive design, and assistive technology compatibility. Conduct audits, identify barriers, and provide remediation guidance.
Explore our most popular utilities designed for the modern Indian creator.