بنقرة واحدة
codebase-documentation
Use when generating or maintaining codebase documentation. Divio framework.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
Use when generating or maintaining codebase documentation. Divio framework.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | codebase-documentation |
| description | Use when generating or maintaining codebase documentation. Divio framework. |
| version | 1.0.0 |
| tags | ["docs","authoring"] |
∀ codebase analysis tasks. ∀ documentation tasks.
| Type | Purpose | Audience | Style |
|---|---|---|---|
| Tutorial | Learning-oriented | New dev | Step-by-step, "do this, then this" |
| How-to | Task-oriented | Working dev | "To achieve X, do Y" |
| Reference | Information-oriented | Any dev | Accurate, complete, terse |
| Explanation | Understanding-oriented | Curious dev | Discursive, "why" focused |
| File | Focus | Content |
|---|---|---|
| STACK.md | Technology | Languages, frameworks, tools, versions, rationale |
| ARCHITECTURE.md | Structure | Patterns, layers, boundaries, data flow |
| CONCERNS.md | Cross-cutting | Tech debt, security, fragile areas, missing coverage |
| CONVENTIONS.md | Standards | Naming, file structure, commit format, review process |
project docs directory (e.g., docs/)Use when reviewing architecture decisions. C4 model, dependency inversion, hexagonal boundaries.
Use during discuss-slice and plan-slice to stress-test a spec or plan against domain vocabulary before approval.
Use during research-slice to build disposable experiments that answer technical uncertainty.
Use during project:init to scaffold repo-level agent configuration (CLAUDE.md, AGENTS.md, tracker labels).
Use when debugging. 4-phase investigation, root cause, minimal fix.
Use when implementing features/fixes. Iron law: ¬∃ production code without failing test.