Documentation Templates & Guidelines
Standardizes project documentation through structured templates for READMEs, APIs, and AI-friendly codebase indexing.
This skill provides Claude with a comprehensive library of documentation patterns and structure guidelines designed to improve project clarity and maintainability. It includes standardized templates for README files, API documentation, JSDoc/TSDoc code comments, and Architecture Decision Records (ADRs). By implementing these patterns, developers can ensure their documentation is scannable for humans and optimized for AI-agent indexing (RAG), facilitating better automated assistance and smoother onboarding for new contributors.
主な機能
01Architecture Decision Record (ADR) and Changelog templates
02JSDoc/TSDoc guidelines for consistent code commenting
03AI-optimized documentation patterns like llms.txt for better RAG
04Standardized README and API documentation structures
05Clear hierarchy and scannable table formats for technical guides
0638,904 GitHub stars
ユースケース
01Documenting RESTful API endpoints with consistent parameter and response tables
02Generating professional README files for new open-source repositories
03Creating AI-friendly project summaries to improve agent performance on complex codebases