القائمة
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 المهني
API documentation specialist for OpenAPI/Swagger specifications. Use when documenting REST or GraphQL APIs.
Designs technical solutions and architecture. Use when user says "design solution", "architecture design", "technical design", or "方案设计" WITHOUT mentioning PRD. For PRD-specific work, use prd-planner skill instead.
Workflow hook metadata for agent-playbook skills. This skill documents trigger intent between skills - DO NOT use directly, and do not assume hooks execute unless the host runtime explicitly supports them.
Reviews pull requests and code changes for quality, security, and best practices. Use when user asks for code review, PR review, or mentions reviewing changes.
Helps write Git commit messages following the Conventional Commits specification. Use this skill when the user asks to commit changes, write commit messages, format commits, or mentions git commits.
Creates pull requests with bilingual documentation checks. Use when user asks to create PR, make a pull request, or submit changes for review. Ensures English and Chinese README files stay in sync when user-facing skill catalog changes require it.
| 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