skills.rest
benshapyro
benshapyroCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-templates

Generate README, API docs, and inline comment templates for software projects.

9|1|Updated Dec 1, 2025
Search Tags:#templates#documentation#readme#comments#docs#api-docs
One-click install
npx skills add https://github.com/benshapyro/cadre-devkit-claude --skill documentation-templates
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/benshapyro/cadre-devkit-claude/tree/main/skills/documentation-templates
Command: npx skills add https://github.com/benshapyro/cadre-devkit-claude --skill documentation-templates

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Automates creation of structured documentation, README files, API docs templates, and helpful inline code comments to keep codebases well-documented.

Core Features & Use Cases

  • README Template: Quick-start README skeletons
  • API Docs Template: Self-contained API documentation sections
  • Inline Comments: Guidance on when/how to comment code
  • ADR & Architecture Docs: Architecture Decision Records and more

Quick Start

Use the templates to scaffold documentation for a project, e.g., "generate a README with sections for setup, usage, and contribution".

Frequently Asked Questions about documentation-templates

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README template for my project?▼

Generate a README template by specifying sections you need—setup, usage, contribution, and API overview are common starting points. The Skill creates structured README skeletons with placeholders and best-practice sections, accelerating documentation workflows and ensuring consistency across projects.

What's the best way to document API endpoints and create API docs?▼

API docs templates provide self-contained sections for endpoint descriptions, parameters, responses, and examples. This Skill generates these structured templates so you can fill in specifics, standardizing API documentation format and reducing manual writing time.

How should I write inline code comments and docstrings?▼

Inline comment guidance covers when and how to annotate code in TypeScript, JSDoc, Python docstrings, and other languages. Templates emphasize explain-why documentation and progressive disclosure, helping maintainers understand intent without cluttering code.

Can I use these templates for Architecture Decision Records and design docs?▼

Yes. The Skill generates ADR templates and architecture documentation sections alongside README and API docs, providing structured frameworks for recording technical decisions and system design across your codebase.

Do I need coding knowledge to use these documentation templates?▼

Templates are human-friendly and require no coding expertise—they're scaffolds you fill in with project details. The Skill handles structure and format; you provide content, making documentation accessible to all team members.

Related Skills

Explore More Content & Communication Skills→
Do1phin0-0Do1phin0-0

contract-drafting

Populate standardized Word templates with project details to draft construction subcontracts.

Community
Advanced
lailtonjuniorlailtonjunior

Documentation

Generate and update Markdown and HTML documentation from code, schemas, and design notes.

Community
Intermediate
raybargasraybargas

Global Commenting

Enforces uniform, standard-based commenting across entire codebases and integrates with linters and static analysis tools for automated checks.

Community
Basic
huangzidahuangzida
2

source-driven-development

Resolve framework patterns from official documentation with cited sources.

Community
Advanced