component-documenter
Write professional documentation including README files, Storybook stories, API docs, usage examples, and migration guides for component libraries
Write professional documentation including README files, Storybook stories, API docs, usage examples, and migration guides for component libraries
Use when writing code - ensure complete JSDoc, docstrings, and inline comments assuming documentation will be generated from code
Use when looking up information from the latest Docusaurus documentation at https://docusaurus.io/docs
Generate enterprise module documentation with 26-section structure and folder hierarchy. Use for module docs, enterprise features, detailed specs in docs/business-features/{Module}/. Includes README, INDEX, API-REFERENCE, detailed-features/. Triggers on "module docs", "enterprise feature docs", "business module", "26-section docs", "detailed feature specs". For single-file quick docs, use feature-docs instead.
Complete SPEC document authoring guide with YAML metadata structure (7 required + 9 optional fields), EARS requirement syntax (5 patterns including Unwanted Behaviors), version lifecycle management, TAG integration, pre-submission validation checklist, and real-world SPEC examples.
Zennでの技術記事・書籍公開の完全ガイド。カバー画像仕様、価格設定、config.yaml設定、GitHubデプロイ、よくあるエラーと対処法まで、Zenn公開の全てをカバー。
Writing effective code documentation - API docs, README files, inline
Generate comprehensive API documentation following OpenAPI 3.0 and REST standards when creating or documenting APIs, endpoints, or web services
Transform reverse-engineering documentation into GitHub Spec Kit format. Initializes .specify/ directory, creates constitution.md, generates specifications from reverse-engineered docs, and sets up for /speckit slash commands. This is Step 3 of 6 in the reverse engineering process.
技術ドキュメント、README、API仕様書、アーキテクチャ図の作成方法。読みやすく、保守しやすく、チームに役立つドキュメント作成のベストプラクティス。
Senior Technical Writer with 10+ years documenting complex systems. Use when creating/updating documentation, writing API docs, creating architecture diagrams (C4, Mermaid), generating changelogs, writing READMEs, or creating onboarding guides.
Generate or update the methods section based on actual scripts in the pipeline. Links code directly to reproducible documentation. Use when the user types /write_methods, after completing scripts, when methods.md is out of sync with code, or before writing results.
Use when user-facing features change. Ensures features documentation is updated. Pauses work if documentation has drifted, triggering documentation-audit skill.
Edit the Mintlify docs site under docs/. Keep docs.json consistent and run a11y/broken-links checks.
Download documentation from GitHub repos or URLs. Supports manifest-based batch downloads with configurable exclude patterns.
JSDoc/TSDoc standards for documenting types, functions, and constructs. Use when writing or reviewing documentation.
Update and reorganize README documentation based on codebase changes. Use when adding features, refactoring modules, updating APIs, or when documentation drifts from implementation.
Use when documentation drift is detected. Comprehensively audits codebase and creates/updates Swagger, features docs, and general documentation to achieve full sync.
Update Javadoc and public documentation after implementing features. Use when finishing implementation to ensure both internal (Javadoc) and external (website docs) documentation are accurate and complete.
Development guide for the dotfiles-installer project. Use when working with package managers (brew, apt, dnf), implementing interfaces, using the commander/logger/filesystem utilities, handling privilege escalation, or understanding the codebase architecture. Covers project structure, key interfaces, configuration files, and development commands. For general Go coding conventions and testing patterns, use the go-dev skill.
Apply documentation standards: comment why not what, minimal comments (prefer clear code), maintain README with quick start, update docs with breaking changes. Use when writing comments, creating docs, reviewing documentation, or discussing what to document.
Guide for writing clear, comprehensive technical documentation including README files, API docs, guides, and inline documentation