Does it include code commenting standards?

Yes, it provides clear JSDoc/TSDoc templates and logic for when to use comments versus when to write self-explanatory code.

What types of documentation does this skill cover?

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

How does this skill support AI-assisted development?

It includes specific guidelines for 'AI-Friendly Documentation,' such as llms.txt and RAG-ready structures, which help AI agents better understand your codebase.

Are the templates customizable?

Yes, all templates serve as foundational structures that you can adapt to your project's specific needs and complexity.

Documentation Templates & Guidelines

Name: Documentation Templates & Guidelines
Author: claudiodearaujo

byclaudiodearaujo

0•

コンテンツ管理

Provides standardized templates and best practices for creating professional, AI-friendly project documentation.

This skill equips developers with a comprehensive suite of documentation patterns designed for the modern AI-assisted development era. It offers structured templates for READMEs, API endpoints, changelogs, and Architecture Decision Records (ADRs), while emphasizing 'AI-friendly' formats like llms.txt and RAG-ready structures. By implementing these standards, developers ensure their projects are easily navigable for both human contributors and AI agents, leading to better code maintainability and clearer communication of project goals.

主な機能

010 GitHub stars

02Standardized README and API documentation templates

03JSDoc and TSDoc code commenting guidelines

04AI-friendly documentation patterns (llms.txt and RAG optimization)

05Architecture Decision Record (ADR) and Changelog structures

06Best practices for scannability and example-first documentation

ユースケース

01Documenting REST API endpoints with consistent parameter and response tables

02Initializing a new project repository with a professional README and documentation structure

03Optimizing documentation for AI crawlers and RAG indexing to improve AI agent performance

What are Skills?·How to Install

Install with 🐟 Skill.Fish

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

For use in Claude.ai and ChatGPT

Download Skill

主な機能

010 GitHub stars

02Standardized README and API documentation templates

03JSDoc and TSDoc code commenting guidelines

04AI-friendly documentation patterns (llms.txt and RAG optimization)

05Architecture Decision Record (ADR) and Changelog structures

06Best practices for scannability and example-first documentation

ユースケース

01Documenting REST API endpoints with consistent parameter and response tables

02Initializing a new project repository with a professional README and documentation structure

03Optimizing documentation for AI crawlers and RAG indexing to improve AI agent performance

What are Skills?·How to Install

Install with 🐟 Skill.Fish

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

For use in Claude.ai and ChatGPT

Download Skill