For consumer projects using @zeix/cause-effect as a dependency, use the cause-effect
skill instead.
Tone adapts to audience. Each document has a distinct primary reader and register.
See references/tone-guide.md. Violating the tone is as wrong as a factual error.
Concise over comprehensive. Every sentence must justify its presence. Cut anything
that does not add information the reader needs. Technical accuracy is non-negotiable;
length is not.
Surgical edits only. Update what changed. Do not rewrite sections that are still
accurate, and do not add commentary about what was updated.
- Update after a code change —
src/ or index.ts has changed and documents need
to reflect it
- Review consistency — check that all documents reflect the current source
- Update a specific document — you know exactly which one
Wait for response before proceeding.
Document-specific routing (option 3):
| Document named |
Workflow |
README.md or GUIDE.md |
workflows/update-public-api.md |
ARCHITECTURE.md |
workflows/update-architecture.md |
CLAUDE.md or copilot-instructions.md |
workflows/update-agent-docs.md |
REQUIREMENTS.md |
workflows/update-requirements.md |
JSDoc / src/ |
workflows/update-jsdoc.md |
Intent-based routing (clear intent without selecting a number):
- "document the new API" / "update README" → workflows/update-public-api.md
- "update the architecture doc" → workflows/update-architecture.md
- "update CLAUDE.md" / "add non-obvious behavior" → workflows/update-agent-docs.md
- "update JSDoc" / "inline docs" → workflows/update-jsdoc.md
- "update requirements" → workflows/update-requirements.md
- "review all docs" / "check consistency" → workflows/consistency-review.md
After identifying the workflow, read it and follow it exactly.
| File |
Contents |
| document-map.md |
Each document's audience, scope, update triggers, and consistency checks |
| tone-guide.md |
Writing tone, register, and conciseness rules per document type |
|
|
| Workflow |
Purpose |
| update-after-change.md |
Determine which documents to update after a code change, then update them in order |
| update-public-api.md |
Update README.md and GUIDE.md |
| update-architecture.md |
Update ARCHITECTURE.md |
| update-agent-docs.md |
Update CLAUDE.md and .github/copilot-instructions.md |
| update-requirements.md |
Update REQUIREMENTS.md |
| update-jsdoc.md |
Update JSDoc comments in src/ |
| consistency-review.md |
Review all documents for consistency with current source |
|
|
Source: zeixcom/cause-effect — distributed by TomeVault.
1---2name: zeixcom-cause-effect-tech-writer3description: <scope>4---56<scope>7This skill is for the cause-effect library repository. It expects source files at `src/`8and `index.ts`, documentation at the project root, and agent instructions at `.github/`.910For consumer projects using `@zeix/cause-effect` as a dependency, use the `cause-effect`11skill instead.12</scope>1314<essential_principles>15**Read source before writing.** Always read the current state of the relevant source file(s)16and the target document before making any changes. Never update from memory.1718**Tone adapts to audience.** Each document has a distinct primary reader and register.19See references/tone-guide.md. Violating the tone is as wrong as a factual error.2021**Concise over comprehensive.** Every sentence must justify its presence. Cut anything22that does not add information the reader needs. Technical accuracy is non-negotiable;23length is not.2425**Surgical edits only.** Update what changed. Do not rewrite sections that are still26accurate, and do not add commentary about what was updated.27</essential_principles>2829<intake>30What do you need to do?31321. **Update after a code change** — `src/` or `index.ts` has changed and documents need33 to reflect it342. **Review consistency** — check that all documents reflect the current source353. **Update a specific document** — you know exactly which one3637**Wait for response before proceeding.**38</intake>3940<routing>41| Response | Workflow |42|---|---|43| 1, "code changed", "after change", "just merged", "new feature", "bug fix" | workflows/update-after-change.md |44| 2, "review", "consistency", "check", "audit", "verify" | workflows/consistency-review.md |45| 3, "specific", or names a document | See document routing below |4647**Document-specific routing (option 3):**4849| Document named | Workflow |50|---|---|51| `README.md` or `GUIDE.md` | workflows/update-public-api.md |52| `ARCHITECTURE.md` | workflows/update-architecture.md |53| `CLAUDE.md` or `copilot-instructions.md` | workflows/update-agent-docs.md |54| `REQUIREMENTS.md` | workflows/update-requirements.md |55| JSDoc / `src/` | workflows/update-jsdoc.md |5657**Intent-based routing (clear intent without selecting a number):**58- "document the new API" / "update README" → workflows/update-public-api.md59- "update the architecture doc" → workflows/update-architecture.md60- "update CLAUDE.md" / "add non-obvious behavior" → workflows/update-agent-docs.md61- "update JSDoc" / "inline docs" → workflows/update-jsdoc.md62- "update requirements" → workflows/update-requirements.md63- "review all docs" / "check consistency" → workflows/consistency-review.md6465**After identifying the workflow, read it and follow it exactly.**66</routing>6768<reference_index>69All in `references/`:7071| File | Contents |72|---|---|73| document-map.md | Each document's audience, scope, update triggers, and consistency checks |74| tone-guide.md | Writing tone, register, and conciseness rules per document type |75</reference_index>7677<workflows_index>78All in `workflows/`:7980| Workflow | Purpose |81|---|---|82| update-after-change.md | Determine which documents to update after a code change, then update them in order |83| update-public-api.md | Update `README.md` and `GUIDE.md` |84| update-architecture.md | Update `ARCHITECTURE.md` |85| update-agent-docs.md | Update `CLAUDE.md` and `.github/copilot-instructions.md` |86| update-requirements.md | Update `REQUIREMENTS.md` |87| update-jsdoc.md | Update JSDoc comments in `src/` |88| consistency-review.md | Review all documents for consistency with current source |89</workflows_index>9091---92> Source: [zeixcom/cause-effect](https://github.com/zeixcom/cause-effect) — distributed by [TomeVault](https://tomevault.io).93<!-- tomevault:4.0:skill_md:2026-06-15 -->