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-templates

SKILL.md

Documentation Templates

Templates and structure guidelines for common documentation types.

1. README Structure

Essential Sections (Priority Order)
SectionPurpose
Title + One-linerWhat is this?
Quick StartRunning in <5 min
FeaturesWhat can I do?
ConfigurationHow to customize
API ReferenceLink to detailed docs
ContributingHow to help
LicenseLegal
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](./docs/api.md)
-[Architecture](./docs/architecture.md)
## 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 algorithmsEvery line
Non-obvious behaviorSelf-explanatory code
API contractsImplementation 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

PrincipleWhy
ScannableHeaders, lists, tables
Examples firstShow, don't just tell
Progressive detailSimple → Complex
Up to dateOutdated = 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

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
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/one-man-company/skills-contextmanager/documentation-templates/badge)](https://verified-skill.com/skills/one-man-company/skills-contextmanager/documentation-templates)

Something wrong with this skill or its page? Tell us.