What documentation types are included?

The skill covers READMEs, API endpoint references, code comments (JSDoc/TSDoc), Changelogs, Architecture Decision Records (ADRs), and specialized AI discovery files.

Does it help with API design documentation?

Yes, it includes a structured per-endpoint template that ensures parameters, response types, error codes, and examples are consistently documented.

How does this skill improve AI interactions with my code?

It implements AI-friendly patterns like llms.txt and clear H1-H3 hierarchies that help AI agents and RAG systems index your project structure and key concepts more accurately.

Can I adapt these templates to my specific project needs?

Absolutely. While the templates provide a rigorous foundation based on industry standards, they are designed to be modified to suit specific technology stacks or organizational requirements.

Documentation Templates

Name: Documentation Templates
Author: claudiodearaujo

byclaudiodearaujo

•

内容管理

Standardizes project documentation with structured templates for READMEs, API references, and AI-optimized metadata.

This skill provides a comprehensive suite of documentation templates designed to improve project clarity and AI discoverability. It offers structured guidelines for everything from README files and API endpoint documentation to Architecture Decision Records (ADRs) and JSDoc comments. By implementing these patterns, developers can ensure their codebases are scannable for humans and optimized for AI context-window consumption through modern standards like llms.txt and MCP-ready structures, facilitating better RAG indexing and automated code understanding.

主要功能

011 GitHub stars

02Best-practice guidelines for creating scannable, example-first technical content

03AI-friendly documentation patterns (llms.txt) for improved crawler and agent discovery

04Ready-to-use Architecture Decision Record (ADR) and Changelog formatting

05Standardized README and API documentation structures with priority sections

06JSDoc and TSDoc templates for clean, expressive, and machine-readable code comments

使用场景

01Establishing a professional versioning and decision-tracking workflow for engineering teams

02Optimizing a legacy codebase for better performance with AI coding assistants and RAG systems

03Standardizing documentation across a multi-repository microservices architecture

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add claudiodearaujo/sistema-de-narra-o-de-livro documentation-templates

For use in Claude.ai and ChatGPT

Download Skill