Can these templates be customized?

Absolutely. The templates are provided as foundational starting points that you can adapt to your specific project needs.

Is this skill compatible with TypeScript?

Yes, it provides specific TSDoc templates for documenting types, parameters, return values, and errors in TypeScript.

What documentation types are included?

The skill covers READMEs, API references, code comments, changelogs, and Architecture Decision Records (ADRs).

How does this skill help with AI performance?

It includes templates for llms.txt and MCP-ready documentation, which optimize your codebase for indexing by AI agents and RAG systems.

Documentation Templates

Name: Documentation Templates
Author: claudiodearaujo

byclaudiodearaujo

学习与文档

Standardizes project documentation through professional templates for READMEs, APIs, and AI-friendly content.

关于

The Documentation Templates skill provides a comprehensive suite of structural guidelines and patterns designed to improve project clarity and maintainability. It equips developers with standardized templates for essential project components, including high-priority README sections, detailed API endpoint documentation, and Architecture Decision Records (ADRs). By focusing on scannability and progressive detail, this skill ensures codebases remain navigable for human collaborators while optimizing for AI-assisted development through modern formats like llms.txt and MCP-ready structures.

主要功能

Standardized README and API reference structures
AI-optimized documentation formats like llms.txt
JSDoc and TSDoc templates for professional code commenting
Architecture Decision Record (ADR) and Changelog patterns
Guidelines for scannable and progressive technical writing
0 GitHub stars

使用场景

Bootstrapping a new project with professional, industry-standard documentation
Standardizing API documentation across a team to improve developer experience
Optimizing a codebase for AI agents and RAG indexing using AI-friendly templates

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

GitHub

关于