القائمة
Write, update, sync, or fix documentation for ink-cartridge. Use when the user wants to write docs, update API docs, sync docs with source changes, or fix documentation errors.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
Write demo/example files for ink-cartridge components and APIs. Use when the user wants to create a demo, write an example, or add a showcase for a component or API.
Write tests for ink-cartridge. Use when the user wants to write tests, add tests, or create test files.
استنادا إلى تصنيف SOC المهني
| name | write-docs |
| description | Write, update, sync, or fix documentation for ink-cartridge. Use when the user wants to write docs, update API docs, sync docs with source changes, or fix documentation errors. |
Must first ask the user to choose an interaction mode:
Then must ask: new doc or updating existing doc?
docs/<subsystem>/README.md)docs/README.md) if entry is neededREADME.md Documentation section (<details> block) with the new linksrc/index.ts — if this API is public and not exported, warn the usersrc/index.tsMust read existing docs in the same subsystem before writing. Must match their section structure, table headers, wording, and code example style exactly.
Typical API doc sections (follow existing, not this list):
# <Name> — one-line summary## Signature — TypeScript signature block## Props or ## Options — table: Prop, Type, Required, Default, Description## Returns — return value description## Best Practice — code examplesComponent API docs may also include ## Keyboard table.
docs/README.md, root README.mdsrc/index.ts for public API export; warn if missingdocs-agents/ (those are manually maintained agent reference files)After writing docs, must remind the user: verify the doc matches the current source truth — no stale props, no missing signatures.