菜单
Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Systematic 4-phase debugging with root cause investigation. Use when fixing bugs to prevent random fixes.
Generate and iterate images in Cursor using the built-in image model and strong prompts. Use when creating icons, illustrations, UI mockups, diagrams, marketing visuals, or any raster asset from a text description or reference image.
Search and navigate large codebases efficiently. Use when finding specific code patterns, tracing function calls, understanding code structure, or locating bugs. Handles semantic search, grep patterns, AST analysis.
Apply appropriate design patterns (Singleton, Factory, Observer, Strategy, etc.) to solve architectural problems. Use when refactoring code architecture, implementing extensible systems, or following SOLID principles.
Writing clear, discoverable software documentation following the Eight Rules and Diataxis framework. Use when creating README files, API docs, tutorials, how-to guides, or any project documentation. Automatically enforces docs/ location, linking requirements, and runnable examples.
Build modern React/Next.js frontends. Use when creating web applications, choosing frontend stack, structuring components, or implementing UI/UX designs. Covers React, Next.js, Tailwind CSS, and component patterns.
| name | documentation-engineer |
| description | Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code. |
| allowed-tools | Read, Write, Edit, Grep, Glob, WebFetch, WebSearch |
| metadata | {"hooks":{"after_complete":[{"trigger":"session-logger","mode":"auto","reason":"Log documentation activity"}]}} |
Expert in creating clear, comprehensive, and maintainable technical documentation.
Activates when you:
Every project should have a README with:
# Project Name
Brief description (what it does, why it exists)
## Quick Start
Installation and usage in 3 steps or less.
## Installation
Detailed installation instructions.
## Usage
Examples of common usage patterns.
## Configuration
Environment variables and configuration options.
## Development
How to run tests, build, and develop locally.
## Contributing
Guidelines for contributors.
## License
License information.
For each endpoint/function:
Comment why, not what:
// Bad: Sets the count to zero
count = 0;
// Good: Reset count for new measurement cycle
count = 0;
// Bad: Check if user is admin
if (user.role === 'admin') {
// Good: Only admins can bypass approval workflow
if (user.role === 'admin') {
Generate documentation structure:
python scripts/generate_docs.py
Validate documentation:
python scripts/validate_docs.py
references/readme-template.md - README templatereferences/api-template.md - API documentation templatereferences/style-guide.md - Documentation style guide