How does this skill help with code commenting?

It provides specific guidelines and templates for JSDoc/TSDoc, emphasizing when to comment (the 'why' and business logic) versus when to let the code speak for itself.

Does it support AI-specific documentation formats?

Yes, it includes specialized templates for llms.txt and MCP-ready documentation designed to optimize your project for LLM-based tools and RAG indexing.

What types of templates are included in the skill?

It includes templates for READMEs, API endpoints, code comments (JSDoc/TSDoc), changelogs, and Architecture Decision Records (ADRs).

What is the main benefit of using this skill?

It provides a standardized framework for all project documentation, making it significantly easier for both developers and AI agents to navigate and understand your codebase.

Documentation Templates & Guidelines

Name: Documentation Templates & Guidelines
Author: claudiodearaujo

byclaudiodearaujo

•

学習とドキュメンテーション

Standardizes project documentation through ready-to-use templates for READMEs, APIs, and AI-friendly discovery files.

This skill provides a comprehensive library of documentation patterns and structure guidelines designed to improve project clarity for both humans and AI agents. It includes standardized templates for README files, API endpoints, JSDoc/TSDoc comments, changelogs, and Architecture Decision Records (ADR), ensuring that codebase documentation is scannable, maintainable, and optimized for modern RAG indexing and AI crawlers like llms.txt. By implementing these patterns, developers can ensure their projects are easily understood by team members and effectively indexed by AI-powered developer tools.

主な機能

01Architecture Decision Record (ADR) and Changelog templates for tracking project evolution

02JSDoc/TSDoc best practices and templates for code-level documentation

03Standardized README structure with priority-ordered essential sections

04AI-friendly documentation patterns (llms.txt) for improved RAG indexing

05Template-driven API documentation for consistent RESTful endpoint descriptions

061 GitHub stars

ユースケース

01Optimizing a repository for AI coding assistants and search crawlers to improve context retrieval

02Initializing a new software project with a professional and consistent documentation structure

03Standardizing internal team documentation to improve developer onboarding and code reviews

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