القائمة
Start here to document what shipped — READMEs, API docs, ADRs, and usage — once a feature lands or an interface changes.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | documentation |
| description | Start here to document what shipped — READMEs, API docs, ADRs, and usage — once a feature lands or an interface changes. |
| context | fork |
| agent | technical-writer |
Document what actually shipped, not what was planned. Read the change, then write the docs a future engineer or agent needs: how to use it, how the interface behaves, and why the key decisions were made.
Docs are only done when they match the shipped behavior. Verify every command, signature, and example against the real code — guesses age into lies.
This skill is ship-time documentation — write the docs once a change lands. For the discipline of capturing decisions as they happen, and the ADR/README formats, see the
documentation-and-adrsskill.
The files written or updated, and a note of anything you found undocumented but out of scope.
Guides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.
Guides systematic root-cause debugging. Use when tests fail, builds break, behavior doesn't match expectations, or you encounter any unexpected error. Use when you need a systematic approach to finding and fixing the root cause rather than guessing.
Start here to ship built-and-tested code to its target safely — release steps, rollout, smoke checks, and rollback.
Start here to settle how a non-trivial change will be built — interfaces, contracts, file-level structure, and trade-offs.
Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
Start here to scout an unfamiliar problem space — research existing solutions, patterns, anti-patterns, constraints, and technical feasibility before committing to an approach.
