What types of documentation does this skill support?

It provides templates for READMEs, API references, code comments (JSDoc/TSDoc), Changelogs, Architecture Decision Records (ADRs), and AI-specific files like llms.txt.

How do the API documentation templates work?

The skill provides a per-endpoint structure that includes parameters, response codes, and example payloads to ensure your API remains scannable and informative.

Does this skill help with AI-ready documentation?

Yes, it includes specific guidelines for llms.txt and MCP-ready documentation to ensure your project is easily indexed and understood by AI agents and RAG systems.

Can I use these templates for TypeScript projects?

Absolutely. It includes TSDoc templates and guidelines for commenting complex logic and API contracts specifically for modern web development.

Documentation Templates

Name: Documentation Templates
Author: claudiodearaujo

byclaudiodearaujo

0•

Learning & Documentation

Standardizes project documentation through professional templates for READMEs, API references, and AI-optimized indexing.

Documentation Templates provides a comprehensive set of blueprints for essential project documentation, ensuring high quality and consistency across your entire codebase. It offers structured guides for professional README files, detailed API endpoint references, changelogs, and Architecture Decision Records (ADRs). Crucially, the skill includes modern standards like llms.txt and MCP-ready structures designed specifically to optimize your documentation for AI consumption and RAG indexing, making it an indispensable tool for modern developers who need their code to be both human-readable and machine-interpretable.

Key Features

01Pre-formatted templates for high-quality READMEs and API docs

020 GitHub stars

03Architecture Decision Record (ADR) and Changelog frameworks

04Best practice principles for scannable and maintainable content

05Comprehensive JSDoc and TSDoc code comment guidelines

06AI-optimized documentation standards including llms.txt

Use Cases

01Standardizing API references and code comments across development teams

02Optimizing documentation for AI crawlers and RAG-based search systems

03Bootstrapping professional documentation for new open-source projects

Key Features

01Pre-formatted templates for high-quality READMEs and API docs

020 GitHub stars

03Architecture Decision Record (ADR) and Changelog frameworks

04Best practice principles for scannable and maintainable content

05Comprehensive JSDoc and TSDoc code comment guidelines

06AI-optimized documentation standards including llms.txt

Use Cases

01Standardizing API references and code comments across development teams

02Optimizing documentation for AI crawlers and RAG-based search systems

03Bootstrapping professional documentation for new open-source projects