Skip to main content
skill

documentation-templates — Claude Code skill for docs

This skill provides outlines and templates for READMEs, API references, code comments, and project records. Use it when starting documentation or bringing existing pages into a clearer structure.

Install into Claude Code · claude-code-templates All methods and platforms ↓
npx claude-code-templates@latest --skill document-processing/documentation-templates
Open on GitHub

What documentation-templates does

The skill includes starting formats for a README, individual API endpoints, JSDoc/TSDoc comments, a changelog, and architecture decision records. Its README outline covers project purpose, setup, configuration, and documentation links. Endpoint entries have slots for parameters, response cases, and a request example. Comment guidance distinguishes explanations of complex behavior or API contracts from comments that merely restate the code.

A separate section covers llms.txt and documentation prepared for RAG indexing. It recommends a clear heading hierarchy, JSON/YAML samples, Mermaid diagrams, and sections that make sense on their own. Treat the formats as starting points and adapt them to the project. The skill is allowed to use Read, Glob, and Grep, so its listed tools support inspecting and searching files, not writing them.

What it helps with

  • draft a README outline with setup and configuration sections
  • document an API endpoint with parameters and response cases
  • add comments for complex logic and API contracts
  • record a project change or architecture decision
  • prepare documentation for AI retrieval and RAG indexing

Example prompts for the agent

  • Draft a README outline for this project using the skill's format.
  • Document these API endpoints with parameters, response cases, and request examples.
  • Review the code comments and suggest where behavior needs explanation and where a comment repeats the code.

How to install documentation-templates

1claude-code-templates

npx claude-code-templates@latest --skill document-processing/documentation-templates

2Skills CLI (Vercel)

npx skills add davila7/claude-code-templates --skill documentation-templates -a claude-code

3Manually: put the files in place

~/.claude/skills/documentation-templates/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/documentation-templates/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about documentation-templates

How do I install documentation-templates in Claude Code?

Run npx claude-code-templates@latest --skill document-processing/documentation-templates. This is one available installation method.

What does documentation-templates do?

It supplies outlines for READMEs, API references, JSDoc/TSDoc comments, changelogs, and architecture decision records. It also covers llms.txt and preparing content for RAG indexing.

Which tools can the skill use in Claude Code?

Its allowed tools are Read, Glob, and Grep. These support reading and searching project files; writing tools are not part of that list.

Similar skills

All skills for Writing and docs →

From the same set495

The whole set →

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor