القائمة
Generate human-readable documentation from code and artifacts
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | openup-create-documentation |
| description | Generate human-readable documentation from code and artifacts |
| model | sonnet |
| arguments | [{"name":"doc_type","description":"Type of documentation (user-guide, api-reference, troubleshooting, tutorial)","required":true},{"name":"feature","description":"Feature or component to document","required":true},{"name":"output_path","description":"Output path for documentation (optional, defaults to docs/user-guides/)","required":false}] |
Generate human-readable documentation from use cases, code, and artifacts.
Based on $ARGUMENTS[doc_type]:
| doc_type | Template | Purpose |
|---|---|---|
| user-guide | user-guide-template.md | End-user documentation |
| api-reference | api-reference-template.md | API documentation |
| troubleshooting | (generated) | Common issues and solutions |
| tutorial | (generated) | Step-by-step learning |
Read relevant sources for the feature: use cases (docs/use-cases/), test cases (docs/test-cases/), design docs (docs/design/), and source code (src/). Adapt sources based on doc_type.
See type-specific files for detailed generation process:
docs/user-guides/<feature>-<doc_type>.md$ARGUMENTS[output_path] if provided/openup-create-documentation doc_type: user-guide feature: user-authentication
/openup-create-documentation doc_type: api-reference feature: payment-api output_path: docs/api/
| Error | Cause | Solution |
|---|---|---|
| No use case found | Feature lacks use cases | Create use cases first |
| Code not found | Feature not implemented | Verify feature name and status |
| Template missing | Template not available | Use generic structure |
docs-eng-process/templates/user-guide-template.mddocs-eng-process/templates/api-reference-template.mdOne-command project setup for OpenUP - interactive initialization wizard
Mark a task as complete, update roadmap, commit changes, and prepare traceability logs
Execute an already-claimed lane's Operations boxes with script/judgment classification — script steps run directly with zero self-brief, judgment steps self-brief and execute. Handles only pick/resume; every other resolve path routes to /openup-next.
Run OpenUP Assess Results at iteration end — check evaluation criteria, demo only completed acceptance-tested work, feed discovered work back, and trigger the milestone review at a phase boundary
Run the phase milestone go/no-go — prepare derived evidence, pause for the human decision via an input-request, and record the milestone (never advance the phase itself)
Begin a new OpenUP iteration with proper phase context and task selection