one-man-company/skills-contextmanager/documentation-templates
Claude Code and agent skill by one-man-company/skills-contextmanager
Trust tier 2
- community
Source check pending
Checking that the SKILL.md file is still in the repository.
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
Install
npx vskill@latest install one-man-company/skills-contextmanager/documentation-templatesSKILL.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
2. API Documentation Structure
Per-Endpoint Template
3. Code Comment Guidelines
JSDoc/TSDoc Template
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)
5. Architecture Decision Record (ADR)
6. AI-Friendly Documentation (2025)
llms.txt Template
For AI crawlers and agents:
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.
Security
- Security scanPassed, 100 of 100Pattern checks on the skill's files.
- Model reviewPassed
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingMySkillsHUB/skills/documentation-templates/skill.md
Popularity
- Repository stars
- 61
- Repository forks
- 14
- Repository npm downloads, 7 days
- 6,951
- 7-day trend score
- 42
Stars and forks are for the whole GitHub repository, not this skill alone. Downloads are for the repository's npm package. Refreshed 21 Mar 2026, 7 months ago.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/one-man-company/skills-contextmanager/documentation-templates)