api-documentation
This skill provides patterns for generating and maintaining API documentation including OpenAPI specs, endpoint documentation, and example generation.
发现 tools technical docs 相关 Skills,比较来源仓库和用途,查看适合你工作流的技能说明。
This skill provides patterns for generating and maintaining API documentation including OpenAPI specs, endpoint documentation, and example generation.
This skill should be used when generating developer onboarding documentation including architecture overviews, setup guides, code tours, and decision records.
Write AI-readable documentation following concise-over-comprehensive principle, hierarchical CLAUDE.md/AGENTS.md inheritance (100-200 line rule), structured formats (tables over prose), parallel validation, and...
Generate comprehensive code documentation including docstrings, comments, and API documentation. Use when code lacks documentation, needs better explanations, or requires API docs. Focuses on clarity, completen...
Creates detailed technical specifications including architecture, data models, APIs, and technology choices. Use when you need to document technical implementation details, system design, or API contracts. Prov...
Create a comprehensive inventory of a codebase. Map structure, entry points, services, infrastructure, domain models, and data flows. Pure documentation—no opinions or recommendations. Use when onboarding to an...
Guide documentation updates when changing versions, adding content, or preparing releases
Converts basic plans into Codex CLI execution-ready documents with embedded context, verification steps, and mandatory code review workflow. Use after creating a plan, or when preparing plans for Codex CLI exe...
Create properly formatted documents for the knowledge base. Use when creating tasks, projects, bookmarks, companies, meetings, people, or research entries. Provides templates, frontmatter schemas, and managemen...
Write self-documenting code with minimal, helpful comments that explain complex logic without documenting temporary changes or fixes. Use this skill when adding comments to code, documenting functions or classe...
Documentation standards and writing guidelines
Generate concise specifications for development tools, editors, and utilities. Use this when planning a new tool, editor plugin, or standalone utility to assist with game development.
JSDoc documentation standards for JavaScript following jsdoc.app conventions. WHEN: Writing JSDoc comments, documenting JavaScript functions/classes/modules, generating API docs with JSDoc, improving existing J...
Write Python docstrings following PEP 257 and popular formats (Google, NumPy, Sphinx). WHEN: Writing docstrings for Python functions/classes/modules, choosing docstring format, documenting parameters/returns/ex...
Write PHP DocBlocks following PSR-5 and PSR-19 PHPDoc standards. WHEN: Writing DocBlocks for PHP classes/methods/functions/properties, documenting @param/@return/@throws, type annotations in PHPDoc. WHEN NOT: P...
TSDoc documentation standards for TypeScript following tsdoc.org conventions. WHEN: Writing TSDoc comments, documenting TypeScript functions/classes/interfaces/types, generating docs with TypeDoc, improving exi...
Modern documentation management with MkDocs Material theme and GitHub Pages publishing. Use when users need to create, maintain, or publish professional documentation websites. Supports initialization of new do...
Guide systematic feature development with codebase exploration, architecture design, and implementation. Use this skill when the user wants to implement a new feature, add functionality, or build something new...
Documentation standards. Apply when completing full feature development, introducing new architecture patterns, or adding new public APIs.
Add new pages to docs.json navigation structure. Updates navigation groups based on user journey (Guides, API Reference, Recipes, etc.). Use when the user asks to add a page to navigation, update docs.json, add...
Expert in documentation structure, audience targeting, and information architecture. Covers technical docs for Software, Hardware, Robotics, and Data Science.
Autonomously analyzes a repository, detects architectural and coding patterns, and generates/updates a docs/ folder with a root CLAUDE.md as table of contents. Use when asked to generate documentation, create C...
Review and improve repository documentation including both human-readable docs (`docs/`), `README.md`, and AI agent memory context files (`CLAUDE.md`, `CODEX.md`, `AGENTS.md`, `.cursorrules`, etc.) for clarity,...
This skill should be used when the user asks to "create a README", "write a README", "generate a README", "improve my README", "make my README better", "README best practices", or mentions needing project docum...
默认按已收录数据中的 GitHub 仓库 Stars 排序。Stars 属于来源仓库,同一仓库的多个技能可能共享相同数值;它反映仓库关注度,不代表单个技能的安装量或质量评分。