documentation

Standardizes READMEs, API docs, ADRs, changelogs with Markdown templates and reviewer checklists.

15|1|Updated Dec 4, 2025

Search Tags:#architecture #documentation #markdown #adr #readme #standards #api-docs

Ready to run

npx skills add https://github.com/FreePeak/ktme --skill documentation-freepeak

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/FreePeak/ktme/tree/main/.kilo/skills/documentation
Command: npx skills add https://github.com/FreePeak/ktme --skill documentation-freepeak

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Standardizes and improves the quality and consistency of project documentation by providing guided workflows, templates, and conventions.

Core Features & Use Cases

Documentation standards templates for README, API docs, architecture decisions, ADRs, changelogs, and inline code docs.
Structured writing guidelines with Markdown templates, versioned organization, and writing tips to ensure clarity and reusability across teams.
Use Case: Apply consistent docs across a multi-repo project to reduce reviewer time and increase knowledge retention.

Quick Start

Start by applying the Documentation Standards template to an existing project and begin drafting docs according to the guidelines.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I standardize README and API documentation across multiple repositories?▼

To standardize README and API documentation, apply consistent frontmatter schemas, Markdown guidelines, and section structures across all repositories. This enforces uniform documentation standards, reducing reviewer time and increasing knowledge retention across multi-repo projects.

What is an ADR and when do I need to document architecture decisions?▼

An ADR, or Architecture Decision Record, captures architectural choices and their context. You need ADRs when making significant structural changes, using standardized templates to ensure architecture notes remain clear, versioned, and reusable for future team reference.

Can I use these documentation templates for changelogs and inline code docs in any programming language?▼

Yes, the documentation standards are applicable to codebases across languages and teams. Templates and writing guidelines support changelogs, inline code docs, API docs, and ADRs, ensuring clarity and reusability regardless of the programming language.

What's the best way to structure a README with Markdown guidelines and frontmatter schemas?▼

The best way to structure a README is by applying the provided Markdown templates that enforce frontmatter schemas and section structure. This guided workflow ensures documentation consistency, provides clear writing tips, and integrates code examples for comprehensive project overviews.

Does standardized documentation include reviewer checklists for API docs and changelogs?▼

Yes, standardized documentation includes reviewer checklists for API docs and changelogs. These checklists enforce frontmatter schemas and Markdown guidelines, ensuring documentation quality and consistency during the code review process across teams.