skills.rest
nishchaydev
nishchaydevCOMMUNITY
Explore all skills by this author →
GitHub

documentation-templates

Standardize documentation with templates for READMEs, API docs, and changelogs.

Updated Feb 2, 2026
Search Tags:#templates#documentation#readme#RAG#api reference#architecture decision records#TSDoc
One-click install
npx skills add https://github.com/nishchaydev/emitra --skill documentation-templates-nishchaydev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/nishchaydev/emitra/tree/main/.agent/skills/documentation-templates
Command: npx skills add https://github.com/nishchaydev/emitra --skill documentation-templates-nishchaydev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the inconsistency and friction teams face when creating documentation by providing ready-to-use structures for READMEs, API docs, code comments, changelogs, ADRs, and AI-friendly indexes.

Core Features & Use Cases

  • README Structure Guidance: Standardizes essential sections in a priority order so new users can get value quickly, including Quick Start, Features, Configuration, API Reference, Contributing, and License.
  • API Documentation Templates: Provides per-endpoint documentation formatting for parameters, responses, and examples to improve maintainability and developer onboarding.
  • Code Comment and TSDoc Guidelines: Encourages documenting why and what contracts exist (rather than noisy implementation details) using a consistent JSDoc/TSDoc pattern.
  • Changelog + ADR Formats: Implements “Keep a Changelog” conventions and a practical ADR structure to record decisions and their consequences.
  • AI-Friendly Documentation Patterns: Offers llms.txt and MCP-ready guidance (clear headings, structured examples) to improve retrieval and indexing.
  • Use Case: Use these templates to quickly convert a partially documented project into a discoverable, onboarding-friendly repository that both humans and AI tools can scan effectively.

Quick Start

Tell the AI: “Using the documentation-templates skill, draft a complete README for my project with Quick Start, Features, Configuration, API Reference links, Contributing, and License, tailored to my stack and folder structure.”

Frequently Asked Questions about documentation-templates

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

FAQPage Schema
How do I standardize README structure for my repository?▼

Standardize README structure by applying a priority order of essential sections, including Quick Start, Features, Configuration, API Reference, Contributing, and License, so new users can quickly get value and onboard easily.

What is the best way to document REST API endpoints for developer onboarding?▼

Document REST API endpoints using per-endpoint formatting templates that require structured parameter, response, and example tables, which improves maintainability and makes developer onboarding significantly smoother.

How does AI-friendly documentation improve RAG indexing?▼

AI-friendly documentation improves RAG indexing by providing llms.txt and MCP-ready guidance with clear headings and structured examples, allowing AI systems to discover, retrieve, and reuse knowledge consistently.

Can I use these templates for TSDoc and JSDoc code comments?▼

Yes, you can use these templates for TSDoc and JSDoc comments. They encourage documenting why contracts exist and what they do using a consistent pattern, rather than adding noisy implementation details.

What format should I use for changelogs and architecture decision records?▼

Use the Keep a Changelog convention for changelogs and a practical ADR structure for architecture decision records to consistently record decisions, their context, and their consequences over time.

Related Skills

Explore More Content & Communication Skills→
RemseyMailjardRemseyMailjard

wiki-qa

Analyze code repositories to answer questions with source-file citations.

Community
Advanced
auxi-wardrobeauxi-wardrobe
1

ck:llms

Generate llms.txt files from documentation directories following the llmstxt.org specification.

Official
Intermediate
PracticalSwanPracticalSwan
7

documentation-automation

Configure markdownlint, link checkers, and pre-commit hooks for documentation validation.

Community
Intermediate
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate