Documentation Templates
Apply README, API endpoint, and code-comment templates so agents produce consistent, AI-friendly project documentation fast.
Overview
Documentation Templates is an agent skill most often used in Build (also Ship launch prep, Grow content) that provides README, API, and code-comment structures for clear project documentation.
Install
npx skills add https://github.com/sickn33/antigravity-awesome-skills --skill documentation-templatesWhat is this skill?
- README template with 7 prioritized essential sections from title through license
- Per-endpoint API doc template with parameters table, status codes, and examples
- JSDoc/TSDoc comment structure for AI-friendly inline documentation
- Marked community-safe skill with explicit documentation-types coverage in frontmatter
- 7 essential README sections in priority order
- Per-endpoint API documentation template with parameters and response tables
Adoption & trust: 1.2k installs on skills.sh; 40.1k GitHub stars; 3/3 security scanners passed (skills.sh audits).
What problem does it solve?
Your repo has no doc standard, so every agent session produces a different README shape and incomplete API pages.
Who is it for?
Solo builders starting or refactoring open-source, API, or CLI projects who want documentation that agents can extend predictably.
Skip if: Teams that already enforce a corporate docs portal with locked templates, or projects needing legal/regulated doc control workflows only.
When should I use this skill?
You need README, API reference, or code comment structure guidelines and templates for a project.
What do I get? / Deliverables
You get consistent README, API endpoint, and comment templates aligned for quick starts, references, and AI-readable codebases.
- README markdown following the essential-sections template
- API endpoint doc pages with parameters, responses, and examples
- JSDoc/TSDoc blocks on public functions and types
Recommended Skills
Journey fit
Spans multiple journey phases - primary shelf plus alternate fits below.
Build / docs is the primary shelf because the skill encodes documentation structure and templates as you implement and publish the product narrative. Docs subphase fits README priority sections, API reference layouts, and JSDoc-style comment guidelines called out in the skill.
Where it fits
Drop in the README table order when bootstrapping a new SaaS repo so Quick Start precedes long configuration prose.
Standardize API endpoint pages before external beta testers arrive so status codes and examples match reality.
Refresh feature bullets and doc links for SEO landing pages without rewriting the whole README from scratch.
How it compares
Use instead of one-off ‘write a README’ prompts when you want repeatable section order and API tables across repos.
Common Questions / FAQ
Who is documentation-templates for?
Indie developers and agent users who want fast, consistent README and API documentation without hiring a technical writer.
When should I use documentation-templates?
Use it in Build when authoring docs, at Ship when polishing setup instructions for reviewers, and at Grow when improving discoverability via clearer feature lists.
Is documentation-templates safe to install?
Frontmatter marks it as safe community content; still review the Security Audits panel on this Prism page before piping secrets into generated examples.
SKILL.md
READMESKILL.md - Documentation Templates
# 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 ```markdown # 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 - Architecture ## License MIT ``` --- ## 2. API Documentation Structure ### Per-Endpoint Template ```markdown ## 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 ```typescript /** * 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) ```markdown # 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) ```markdown # 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: ```markdown # 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. ## When to Use This skill is applicable to execute the workflow or actions described in the overview. ## Limitations - Use this skill only when the task clearly matches the scope described above. - Do not treat the output as a substitute for environment-specific validation, testing, or expert review. - Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.