documentation-templates

Provides templates and structure guidelines for READMEs, API docs, changelogs, and ADRs.

2|Updated Jan 10, 2026

Search Tags:#changelog #templates #documentation #markdown #adr #readme #api docs

Ready to run

npx skills add https://github.com/Shubh2310-developer/ENGUNITYCORE --skill documentation-templates-shubh2310-developer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/Shubh2310-developer/ENGUNITYCORE/tree/main/.claude/skills/documentation-templates
Command: npx skills add https://github.com/Shubh2310-developer/ENGUNITYCORE --skill documentation-templates-shubh2310-developer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, well-structured documentation is time-consuming, and teams often produce inconsistent READMEs, API references, and changelogs that confuse users and AI tools alike. ## Core Features & Use Cases - Ready-to-use templates: Markdown skeletons for READMEs, per-endpoint API docs, changelogs (Keep a Changelog format), and Architecture Decision Records. - Code comment guidelines: JSDoc/TSDoc comment templates plus rules on when to comment and when not to. - AI-friendly documentation: llms.txt templates and MCP-ready structuring guidance (clear heading hierarchy, JSON/YAML examples, Mermaid diagrams) for RAG indexing and AI crawlers. - Use Case: When starting a new open-source project, use this Skill to generate a complete README with quick start, features, configuration table, and license sections following the recommended priority order. ## Quick Start Ask the assistant to generate a README for your project following the documentation templates structure.

Frequently Asked Questions about documentation-templates

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

FAQPage Schema

How do I write a good README for my project?▼

A good README starts with a title and one-line description, followed by a quick start section runnable in under five minutes. Then add features, a configuration table, links to detailed docs, contributing guidelines, and license information in that priority order.

What sections should API documentation include per endpoint?▼

Each endpoint should document the HTTP method and path, a brief description, a parameters table with name, type, required flag, and description, possible response codes, and a concrete request/response example.

What is an llms.txt file and why use one?▼

An llms.txt file is a Markdown file that gives AI crawlers and agents a concise map of your project, including a one-line objective, core file paths, and key concepts. It improves how AI tools index and understand your documentation.

When should I write code comments versus avoid them?▼

Comment the why behind business logic, complex algorithms, non-obvious behavior, and API contracts. Avoid commenting obvious code, every line, self-explanatory statements, or implementation details that the code already expresses.

How do I structure an Architecture Decision Record?▼

An ADR contains four sections: Status (Accepted, Deprecated, or Superseded), Context explaining why the decision is needed, Decision stating what was chosen, and Consequences describing the trade-offs involved.