futurefin-docs-and-writing

Updates FutureFin's docs of record and CHANGELOG entries following house writing conventions.

1|Updated May 2, 2026
One-click install
npx skills add https://github.com/maxlainz/FutureFin --skill futurefin-docs-and-writing-maxlainz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: futurefin-docs-and-writing
Source: https://github.com/maxlainz/FutureFin/tree/main/.claude/skills/futurefin-docs-and-writing
Command: npx skills add https://github.com/maxlainz/FutureFin --skill futurefin-docs-and-writing-maxlainz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When code changes land without matching documentation updates, docs drift from reality and become misleading. This Skill enforces FutureFin's rule that every change to routes, schema, env vars, engine behavior, tests, or visuals must update its owning doc in the same PR, and defines exactly how CHANGELOG entries and reference docs must be written. ## Core Features & Use Cases - Doc-of-record map: A table assigning every fact a single authoritative home (CLAUDE.md, .claude/.md reference docs, CHANGELOG.md, README.md, SECURITY.md, docs/.md) so facts never rot in duplicate. - Change-type to docs checklist: Maps each kind of change (new route, migration, env var, metric, UI token, container behavior) to the exact files that must be updated. - House style and templates: Forensic CHANGELOG entry format (symptom, root cause, fix, lesson), Keep a Changelog 1.1.0 plus SemVer structure, migration-note skeleton, and language conventions (Spanish narrative with English technical terms). - Standing errata register: A tracked table of known doc/code disagreements with verification dates, so known-wrong facts are never left unrecorded. - Use Case: After adding a new API route, run through the checklist to update .claude/api-routes.md, evaluate MCP parity, and draft a forensic CHANGELOG entry under [Unreleased] before the PR is considered complete. ## Quick Start Ask the assistant to document the change you just made and update the matching docs of record, for example: add a CHANGELOG entry and update the reference docs for the new endpoint I added.

Frequently Asked Questions about futurefin-docs-and-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a CHANGELOG entry for FutureFin?▼

CHANGELOG entries follow Keep a Changelog 1.1.0 with SemVer, newest release first under an [Unreleased] bucket. Fixes must be forensic: observable symptom, exact root cause with code identifiers in backticks, the fix, and why it does not regress. Use bold-lead-then-detail bullets and Spanish narrative with English technical terms.

Which doc do I update after adding a route or env var?▼

New or changed routes go in .claude/api-routes.md plus an MCP parity evaluation. New or changed env vars go in .claude/env-and-config.md, the README env table if it is a production variable, and .env.example. The Skill's change-type checklist maps every change to its owning docs.

When should documentation be updated relative to code changes?▼

Documentation must be updated in the same PR as the code change, never after. A PR that adds a route without touching api-routes.md is incomplete. A doc may lag the code temporarily but must never describe behavior the code does not yet have.

What language should FutureFin documentation be written in?▼

Code identifiers, API fields, SQL, and commands are always English. CHANGELOG narrative is Spanish with English technical terms embedded untranslated. Reference docs mix Spanish and English; match the surrounding section. Skills are written in English keeping Spanish project vocabulary.

What are the limitations of this documentation skill?▼

It covers only the writing half of the release ritual. Deciding whether a change may ship belongs to futurefin-change-control, debugging to futurefin-debugging-playbook, test authoring to futurefin-validation-and-qa, and FIRE math content to futurefin-fire-domain-reference.

How is known doc drift tracked in FutureFin?▼

Known doc/code disagreements are recorded in a standing errata table with the document location, what it says, the verified reality, and a verification date. When a disagreement is found, verify against the code as ground truth, fix the doc in the same change, or register the errata if the fix is out of scope.