القائمة
Write or improve technical documentation. Use when the user asks to document code, write a README, generate API docs, write a technical spec, or explain how something works for other engineers.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | docs-writer |
| description | Write or improve technical documentation. Use when the user asks to document code, write a README, generate API docs, write a technical spec, or explain how something works for other engineers. |
When writing a project README:
# Project Name
One-sentence description of what this is and who it's for.
## What it does
2-3 sentences max. No fluff.
## Requirements
List of dependencies and versions.
## Setup
Step-by-step, copy-pasteable commands.
## Usage
The most common use case shown with a real example.
## Configuration
Table of env vars or config options with defaults and descriptions.
## Development
How to run tests, linter, local dev server.
## Contributing
Keep it brief unless this is a public project.
When documenting functions:
Structure for Architecture Decision Records:
## Title
## Status (proposed / accepted / deprecated)
## Context — what problem are we solving?
## Decision — what did we choose?
## Consequences — what are the trade-offs?
Design or review REST APIs, define endpoints, request/response schemas, or evaluate API contracts. Use when the user is designing a new API, reviewing an existing one, or asking about HTTP conventions.
Perform a structured code review. Use when the user asks to review code, check a PR, audit a file, or validate an implementation against best practices.
Systematically investigate and fix bugs, errors, or unexpected behavior. Use when the user reports a bug, shares an error/stacktrace, or asks why something isn't working.
Improve the internal structure of code without changing its behavior. Use when the user asks to clean up, refactor, simplify, or reduce complexity in existing code.
Review code or configuration for security vulnerabilities. Use when the user asks to audit security, check for vulnerabilities, review auth logic, or validate input handling.
Implement tasks from the change, writing actual code following the specs and design. Trigger: When the orchestrator launches you to implement one or more tasks from a change.