skills.rest
martialarcon
martialarconCOMMUNITY
Explore all skills by this author →
GitHub

documentation-templates

Generate standardized templates for READMEs, API references, and changelogs.

1|Updated Feb 15, 2026
Search Tags:#changelog#templates#documentation#adr#readme#code comments#api docs
One-click install
npx skills add https://github.com/martialarcon/claude-code-expert --skill documentation-templates-martialarcon
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/martialarcon/claude-code-expert/tree/main/.agents/skills/documentation-templates
Command: npx skills add https://github.com/martialarcon/claude-code-expert --skill documentation-templates-martialarcon

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides standardized templates and guidelines for various documentation types, ensuring consistency, clarity, and maintainability across projects.

Core Features & Use Cases

  • README Structure: Offers a prioritized section breakdown for effective project overviews.
  • API Documentation: Provides a template for documenting individual API endpoints.
  • Code Commenting: Guides on when and how to write effective code comments using JSDoc/TSDoc.
  • Changelog & ADRs: Includes templates for Keep a Changelog and Architecture Decision Records.
  • AI-Friendly Docs: Outlines a format for llms.txt and RAG-ready documentation.
  • Use Case: A new developer joins a project and needs to understand how to document new features; this skill provides the exact templates and guidelines to follow.

Quick Start

Use the documentation-templates skill to generate a README structure for a new project.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
How do I structure a README for a new software project?▼

To structure a README for a new software project, use a standardized template providing a prioritized section breakdown for effective project overviews, ensuring consistency and clarity across your software engineering documentation.

What is the best way to document API endpoints and code comments?▼

The best way to document API endpoints and code comments is to use standardized templates for individual endpoints alongside JSDoc or TSDoc guidelines, ensuring your technical documentation is scannable and consistently formatted.

How do I format Architecture Decision Records and changelogs?▼

To format Architecture Decision Records and changelogs, apply standardized templates based on the Keep a Changelog format and ADR guidelines, ensuring consistent structural practices for recording project updates and architectural decisions.

Can I use standardized templates to generate AI-friendly documentation?▼

Yes, you can generate AI-friendly documentation by applying standardized templates that outline formats for llms.txt and RAG-ready content, facilitating improved discoverability and processing of your project docs by LLMs.

When do I need to use standardized documentation templates?▼

You need to use standardized documentation templates when onboarding new developers who must understand how to document features, ensuring they follow exact structural guidelines for maintaining up-to-date and scannable project references.

Related Skills

Explore More Software Engineering Skills→
artsmcartsmc
3

memorybank-initialize

Create six core Memory Bank documentation files with starter templates.

Community
Intermediate
musher-devmusher-dev

generating-llm-indexes

Generate llms.txt and llms-full.txt documentation indexes for AI assistants and RAG ingestion.

Official
Intermediate
miounet11miounet11

Doc Generator

Generate and improve code documentation across JSDoc, README, and API specs.

Community
Intermediate
masrurimzmasrurimz

doc-writer

Generate JSDoc/TSDoc comments, READMEs, and API documentation across codebases.

Community
Basic