Conectar

Documentation Templates & Guidelines

sickn33bysickn33
•
39k
•
Aprendizaje y Documentación

Provides structured templates and best-practice guidelines for creating professional READMEs, API documentation, and AI-optimized repository metadata.

This skill equips Claude with a comprehensive library of documentation standards, enabling the rapid generation of high-quality technical content. It covers everything from scannable README structures and detailed API endpoint references to Architecture Decision Records (ADRs) and 'Keep a Changelog' formats. Additionally, it includes modern patterns for AI-friendly documentation like llms.txt, ensuring your codebase is easily indexable by RAG systems and AI agents while maintaining clear human-readable guidance for contributors.

Características Principales

01AI-optimized documentation structures including llms.txt and MCP-ready indexing.
02Standardized README and API documentation templates for immediate project setup.
03Automated changelog formatting based on industry-standard conventions.
04Architecture Decision Record (ADR) frameworks to document technical trade-offs.
0538,904 GitHub stars
06Best-practice guidelines for JSDoc/TSDoc and strategic code commenting.

Casos de Uso

01Improving codebase discoverability for AI agents and LLM-powered developer tools.
02Standardizing internal team documentation through ADRs and consistent API schemas.
03Initializing a new open-source project with professional-grade documentation and licensing.