documentation-templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
Profile →npx skills add sickn33/agentic-awesome-skills --skill documentation-templates --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# 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
- 1. README Structure
- Essential Sections (Priority Order)
- README Template
- 2. API Documentation Structure
- Per-Endpoint Template
- 3. Code Comment Guidelines
- JSDoc/TSDoc Template
- When to Comment
- 4. Changelog Template (Keep a Changelog)
- 5. Architecture Decision Record (ADR)
- 6. AI-Friendly Documentation (2025)
- llms.txt Template
- MCP-Ready Documentation
- 7. Structure Principles
What does the documentation-templates skill do?
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
How do I install it?
Run `npx skills add sickn33/agentic-awesome-skills --skill documentation-templates --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From sickn33/agentic-awesome-skills, a repository with 44,414 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.