phoenix-docs-sync

Documentation drift occurs when code behavior changes but JSDoc and calculation docs aren't updated. This Skill automatically syncs documentation with actual implementation after modifications to XIRR, waterfall, fees, capital allocation, exit recycling, or reserve logic, ensuring docs describe what the module computes.

Update JSDoc whenever non-trivial changes occur to calculation modules, including truth-case semantics, clawback, or precision clarifications. This Skill triggers documentation updates automatically, adding parameters, returns, and semantics to prevent information from becoming outdated.

Synchronization includes plain English descriptions of module computations, key assumptions and invariants, truth-case ID references, and JSDoc parameters and returns. It targets XIRR, waterfall, fees, capital allocation, exit recycling, and reserve logic changes.

Manual JSDoc updates create drift risk between code behavior and documentation. Automated synchronization eliminates this by linking documentation updates directly to calculation changes, ensuring JSDoc semantics remain consistent with actual module behavior.

This Skill ensures documentation highlights key assumptions and invariants alongside parameter and return descriptions in JSDoc. When calculation logic changes, documentation updates to reflect new constraints and behaviors.