Agent skill

phoenix-docs-sync

Syncs calculations documentation and JSDoc with actual behavior. Use after non-trivial changes to calculation modules.

View SKILL.md on GitHub Repository
Stars 0
Forks 0

Install this agent skill to your Project

npx add-skill https://github.com/nikhillinit/Updog_restore/tree/main/.claude/skills/phoenix-docs-sync

SKILL.md

Phoenix Docs Sync

You keep docs and comments aligned with reality for all calculation modules.

When to Use

  • After modifying:
    • XIRR, waterfall, fees, capital allocation, exit recycling, or reserve logic
  • When:
    • Truth-case semantics change
    • Clawback behavior is clarified or corrected
    • Precision / Decimal.js logic changes

Targets

  • docs/calculations.md
  • Relevant sections in README.md
  • JSDoc in:
    • server/analytics/*.ts
    • Shared types for waterfalls, fees, etc.
  • Phase reports:
    • docs/phase0-validation-report.md
    • docs/phase1a-completion-report.md

Workflow

  1. Read the updated code and any relevant truth-case JSONs.
  2. Update documentation to:
    • Describe what the module computes in plain English.
    • Highlight key assumptions and invariants.
    • Reference example truth-case IDs where helpful.
  3. Update JSDoc:
    • Parameters
    • Returns
    • Semantics (especially around clawback and precision)
  4. Ensure no documentation mentions outdated semantics (e.g., "hard floor" for clawback when implementation is shortfall-based partial).

Invariants

  • Docs must never contradict the actual implementation or truth cases.
  • Any semantic change to a calculation should be reflected in docs and JSDoc in the same PR or change set.

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

nikhillinit/Updog_restore

financial-calc-correctness

0 0
Explore
nikhillinit/Updog_restore

statistical-testing

0 0
Explore
nikhillinit/Updog_restore

ui-ux-pro-max

UI/UX design intelligence. 50 styles, 21 palettes, 50 font pairings, 20 charts, 9 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind, shadcn/ui). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, mobile app, .html, .tsx, .vue, .svelte. Elements: button, modal, navbar, sidebar, card, table, form, chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, flat design. Topics: color palette, accessibility, animation, layout, typography, font pairing, spacing, hover, shadow, gradient. Integrations: shadcn/ui MCP for component search and examples.

0 0
Explore
nikhillinit/Updog_restore

code-reviewer

Comprehensive multi-AI code review system for Python, JavaScript, and TypeScript. Use when reviewing code for quality, security, performance, or best practices. Includes automated analysis scripts, language-specific patterns, and AI collaboration workflows for complex decisions.

0 0
Explore
nikhillinit/Updog_restore

dependency-guardian

Automated dependency management with security scanning, update orchestration, and compatibility validation

0 0
Explore
nikhillinit/Updog_restore

documentation-sync

Detects code/documentation drift, validates examples, generates diagrams, auto-updates documentation

0 0
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results