What documentation types are included in this skill?

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

Why should I use ADR templates?

Architecture Decision Records (ADRs) help capture the 'why' behind technical decisions, providing context for future maintainers that isn't always obvious in the code itself.

Is it compatible with TypeScript projects?

Absolutely. It features specific guidelines for JSDoc and TSDoc that work seamlessly with TypeScript for providing hover-over documentation in IDEs.

Does this skill help with AI agent compatibility?

Yes, it includes specialized templates for AI-friendly documentation and MCP-ready structures designed to help LLMs and RAG systems better understand your project.

Documentation Templates & Standards

Name: Documentation Templates & Standards
Author: claudiodearaujo

byclaudiodearaujo

•

内容管理

Standardizes project documentation through professional templates for READMEs, API references, code comments, and AI-friendly metadata.

Documentation Templates provides a comprehensive framework for creating high-quality, structured documentation across the entire development lifecycle. It offers ready-to-use templates for essential project files including READMEs, API endpoints, changelogs, and Architecture Decision Records (ADRs). A unique feature of this skill is its focus on modern AI-readiness, offering guidelines for llms.txt and MCP-ready documentation to ensure your project is easily indexed and understood by AI agents and RAG systems. It is an essential tool for maintaining consistency, improving onboarding, and ensuring codebases remain maintainable and discoverable.

主要功能

01Standardized README and API reference structures for rapid project setup.

021 GitHub stars

03JSDoc and TSDoc guidelines for consistent, high-quality code comments.

04AI-friendly documentation patterns like llms.txt for enhanced RAG indexing.

05Proven documentation principles including progressive detail and scannability.

06Structured templates for Changelogs and Architecture Decision Records (ADRs).

使用场景

01Bootstrapping a new repository with professional-grade documentation from day one.

02Updating legacy codebases with standardized API references and ADRs.

03Optimizing a project for AI-assisted development and LLM crawlers.

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