documentation-templates

Create standardized documentation templates for READMEs, API docs, code comments, changelogs, and ADRs.

Updated Aug 30, 2024
One-click install
npx skills add https://github.com/jfrometa/esquizo --skill documentation-templates-jfrometa
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-templates
Source: https://github.com/jfrometa/esquizo/tree/main/.agent/skills/documentation-templates
Command: npx skills add https://github.com/jfrometa/esquizo --skill documentation-templates-jfrometa

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides ready-to-use templates and guidelines to standardize documentation across projects.

Core Features & Use Cases

  • Documentation templates for README structure, API docs, code comments, and architecture notes.
  • Changelog and ADR templates to keep project history and decisions organized.
  • AI-friendly documentation patterns and structure guidance to improve readability and AI consumption.

Quick Start

Copy or adapt the templates from this Skill (documentation-templates) to your project, customize the frontmatter (name and description), and integrate the sections into your existing documentation workflow.

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 and API docs across multiple projects?

Standardize README structure and API docs by applying ready-to-use documentation templates that enforce consistent sections and content guidelines across software projects. Copy or adapt these templates into your workflow to maintain uniform project documentation.

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

Organize changelogs and architecture decision records (ADRs) by using pre-built templates designed to keep project history and technical decisions structured. These templates provide standardized formats that improve readability and historical tracking.

How do I create AI-friendly documentation patterns for code comments?

Create AI-friendly documentation patterns for code comments by following structure guidelines that improve readability and AI consumption. These templates ensure your code comments use consistent formats optimized for automated parsing and human understanding.

Do I need YAML frontmatter to use these documentation templates?

You need YAML frontmatter containing name and description fields in your SKILL.md file to use these documentation templates. The frontmatter enables proper template integration and supports optional scripts, references, and assets directories for extended resources.

Can I customize the documentation templates for my existing workflow?

You can customize the documentation templates for your existing workflow by copying or adapting them to your project. Modify the YAML frontmatter and integrate specific sections into your current documentation process without starting from scratch.