doc-templates

Generate deterministic markdown templates for README, API docs, ADRs, and changelogs.

Updated Jan 24, 2026
One-click install
npx skills add https://github.com/pikakit/agent-skills --skill doc-templates-pikakit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-templates
Source: https://github.com/pikakit/agent-skills/tree/main/.agent/skills/doc-templates
Command: npx skills add https://github.com/pikakit/agent-skills --skill doc-templates-pikakit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Doc Templates skill provides deterministic, reusable templates for core documentation artifacts (README, API docs, ADRs, and changelogs) and supportive tooling (Mermaid diagrams, markdown previews, and plan dashboards), ensuring consistency and quality at scale.

Core Features & Use Cases

  • Predefined templates for README, API docs, ADR, and changelog with fixed sections and formatting
  • Mermaid diagram editor support and markdown preview to visualize architecture and flows
  • Plan dashboard and llms.txt context generation for AI-assisted discovery and planning
  • Enforces documentation governance: 3-part comment guidelines, structured contracts, and deterministic outputs
  • Use cases include project onboarding, API reference generation, architecture decision records, and release notes

Quick Start

Run the doc-templates skill to retrieve a ready-to-fill template for your document type (README, API docs, ADR, or changelog).

Frequently Asked Questions about doc-templates

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

FAQPage Schema
How do I create consistent documentation templates for software projects?

To create consistent documentation templates, you need predefined structures for core artifacts like READMEs, API docs, ADRs, and changelogs. This approach enforces fixed sections and formatting to reduce drift and standardize documentation workflows across teams.

What is the best way to standardize architecture decision records and changelogs?

The best way to standardize architecture decision records and changelogs is to apply deterministic templates with strict section orders. This ensures fixed formatting and structured contracts, producing ready-to-fill markdown outputs that enforce documentation governance.

Can I use markdown and mermaid diagrams for API documentation generation?

Yes, you can use markdown and mermaid diagrams for API documentation generation. This combination supports diagram editing and markdown previews to visualize architecture and flows, ensuring structured contracts and consistent API references.

Does generating fixed structure documentation require auto-invocation?

Generating fixed structure documentation does not require auto-invocation. The process outputs ready-to-fill markdown templates with strict section orders and formatting, requiring manual execution to retrieve the specific document type needed.

What are the limitations of using deterministic templates for project onboarding?

A limitation of using deterministic templates for project onboarding is that they provide fixed structures and strict section orders without generating content automatically. Users must manually fill in the predefined markdown templates, which may lack flexibility for non-standard documents.