documentation-templates

Create consistent documentation templates with frontmatter for software projects.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation for software projects is often inconsistent, scattered, and hard to maintain. This Skill provides standardized templates and frontmatter structures to ensure uniform README, API references, and code-comment guidance across repositories.

Core Features & Use Cases

  • Centralized templates for README, API docs, and code comments.
  • Structured frontmatter to enable automatic indexing and discovery.
  • AI-friendly guidance for generating consistent docs and architecture diagrams.

Quick Start

Create a complete README and API documentation set following the templates in this Skill.

Frequently Asked Questions about documentation-templates

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

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

Standardized documentation templates for multiple software repositories are created by applying a frontmatter-driven structure to ensure uniform README, API references, and code comments across your projects. This approach enables automatic indexing and consistent documentation workflows.

What is AI-friendly documentation and how does frontmatter structure improve it?

AI-friendly documentation uses structured frontmatter to enable automatic indexing and discovery, allowing AI tools to easily parse and generate consistent docs. This frontmatter-driven structure ensures uniform API references and architecture diagrams across your repositories.

How do I generate a complete README and API reference set for a new project?

You generate a complete README and API documentation set by applying centralized templates that specify a frontmatter-driven structure. These core templates guide the creation of uniform README files, API references, and code comments for your software project.

Does this approach work for architecture decision records and code comments?

Yes, this approach works for architecture decision records and code comments by providing centralized templates and structured guidance. It ensures scalable documentation practices across ADRs, API docs, and inline code comments.

What is the best way to maintain uniform API docs and code comments across scattered repositories?

The best way to maintain uniform API docs and code comments across scattered repositories is using centralized templates with structured frontmatter. This enables automatic indexing, discovery, and consistent documentation workflows across multiple repos.