skills.rest
raccioly
racciolyCOMMUNITY
Explore all skills by this author →
GitHub

documentation-templates

Generates README, API docs, code comment, changelog, and ADR templates with defined sections.

Updated Mar 18, 2026
Search Tags:#templates#documentation#readme#ai-friendly#guidelines#code-comments#api-docs
One-click install
npx skills add https://github.com/raccioly/coach-gravity --skill documentation-templates-raccioly
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/raccioly/coach-gravity/tree/main/content/starter-kit/skills/documentation-templates
Command: npx skills add https://github.com/raccioly/coach-gravity --skill documentation-templates-raccioly

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often lacks consistency and structure across README, API docs, and internal guidance. This skill provides templates and structure guidelines to standardize documentation artifacts across a project.

Core Features & Use Cases

  • Ready-to-use README structure templates (title, quick start, features, configuration, documentation, license)
  • API documentation templates with per-endpoint structure
  • Code comment guidelines and architecture decision record (ADR) templates
  • AI-friendly documentation scaffolding for search and onboarding
  • Use Case: A team adopts these templates to quickly generate consistent docs for new modules and maintain alignment as the project evolves.

Quick Start

Apply the documentation templates to your project to generate consistent README, API docs, and code-comment templates.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
How do I standardize project documentation structure across my development team?▼

To standardize project documentation structure, you apply consistent README, API, and code comment templates. This ensures all software modules share a uniform layout, making docs easier to navigate and onboard across teams.

What is the best way to generate AI-friendly documentation scaffolding for a new module?▼

AI-friendly documentation scaffolding uses YAML-frontmatter templates and defined section schemas to generate structured docs. This makes README files and API endpoints easily parseable by search tools and automated onboarding systems.

Can I use these templates for both README files and API endpoint documentation?▼

Yes, you can use these templates for both README files and API endpoint documentation. The templates provide ready-to-use structures for titles and quick starts, alongside per-endpoint schemas for API docs to maintain alignment.

Does this skill include templates for architecture decision records and changelogs?▼

Yes, this skill includes templates for architecture decision records (ADRs) and changelogs. It provides code comment guidelines and structured schemas to automate documentation creation across various software project artifacts.

How do I create consistent code comment guidelines for my software project?▼

You create consistent code comment guidelines by applying predefined structure templates to your software project. These templates standardize internal guidance and code comments, ensuring documentation remains uniform as the project evolves.

Related Skills

Explore More Content & Communication Skills→
pradeepmoulipradeepmouli
2

speckit-baseline

Generate baseline-spec.md and current-state.md from repository analysis.

Community
Advanced
fabioc-alohafabioc-aloha
1

API Documentation Skill

Scaffold technical documentation projects with templates for API endpoints and guides.

Community
Intermediate
kissrosecicd-hubkissrosecicd-hub
31

secrets-scanner

Detect leaked credentials and secrets across codebases and version histories.

Community
Advanced
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced