fec-doc-sync
Installation
SKILL.md
Document synchronization
Purpose
Synchronize front-end project documentation from code, configuration, tests, types, scripts and runtime templates to avoid README, docs, environment variable descriptions, API/routing descriptions, architectural decisions and migration notes from drifting from actual project behavior.
Procedure
- Identify the project stack, document entry and the scope that needs to be synchronized this time; README synchronization must scan the root directory
README*,docs/*/README*, package, application, deployment or runtime related README, and excludenode_modules, build products and third-party dependency directories. - Gather sources of truth:
package.json, lockfile, framework and build configurations,.env.example, routes, API clients or server routes, types/schemas, components, tests, CI, build/deploy config. - Compare commands, environment variables, routes, API behaviors, deployment steps and support matrix in README, docs, ADR, changelog, example prompts, setup/deploy/env docs.
- Only update stable public conventions; do not write temporary debugging conclusions, one-time reports or unimplemented designs into long-term documents.
- If the warehouse already has multilingual documents or internationalized README, after updating the public facts of the main README, you must check whether other language READMEs need to be synchronized; function names, command names, script names, package names, component/API names, report file names, paths, environment variables, routing/API names, version constraints, and support matrices must be consistent across languages.
- Product copy can maintain localized expression, but must not retain old facts, old default recommendations, or expired examples; when high-quality translation is not possible, at least synchronize key facts, and mark the risks of manual translation in the output.
- When the project exposes plug-ins, SDKs, CLIs, component libraries, templates or integration capabilities, synchronize the corresponding function list, integration instructions, command/script instructions, public metadata, example prompt words or example usage.
- Run relevant documentation consistency, legacy searches, report format consistency, type checks, testing, build or packaging checks.