接続

Professional Documentation Templates

sickn33bysickn33
•
32k
•
学習とドキュメンテーション

Standardizes technical documentation through high-quality templates for READMEs, API references, and AI-optimized indexing files.

This skill provides a comprehensive library of standardized templates and structural guidelines designed to streamline the creation of technical documentation. It covers essential developer artifacts including README files, JSDoc comments, API endpoint documentation, Architecture Decision Records (ADRs), and modern AI-friendly formats like llms.txt. By implementing these patterns, developers can ensure their projects remain scannable, maintainable, and optimized for both human collaborators and AI-driven agents using RAG (Retrieval-Augmented Generation).

主な機能

01Best practices for scannable and progressively detailed content
02Architecture Decision Record (ADR) and Changelog structures
03Standardized scaffolds for READMEs and API documentation
04Ready-to-use JSDoc and TSDoc comment patterns
0531,722 GitHub stars
06AI-optimized documentation formats like llms.txt and MCP-ready docs

ユースケース

01Initializing a new project repository with comprehensive documentation
02Recording major technical design choices using Architecture Decision Records
03Documenting RESTful API endpoints for internal or external developers