fec-doc-sync

Synchronizes frontend project documentation from code, configuration, and runtime sources.

21|3|Updated Mar 17, 2026
One-click install
npx skills add https://github.com/bovinphang/frontend-craft --skill fec-doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fec-doc-sync
Source: https://github.com/bovinphang/frontend-craft/tree/main/localized/zh-CN/skills/fec-doc-sync
Command: npx skills add https://github.com/bovinphang/frontend-craft --skill fec-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

从代码、配置、环境变量和架构文档等事实源同步前端项目文档,避免 README、docs、ADR、变更日志与实际行为漂移。

Core Features & Use Cases

  • 自动收集并汇总项目中的关键事实来源(package.json、锁定文件、框架配置、.env.example、路由、API 客户端或服务器路由、类型和组件信息、测试、CI、构建/部署配置、ADR、changelog)。
  • 将这些事实与现有的 README/docs/ADR/Changelog 进行对比,确保文档保持最新、准确和一致。
  • 支持跨语言文档的同步,保持主语言与其他语言版本的一致性。

Quick Start

执行文档同步,将代码、配置、路由和示例生成的事实更新到主文档中。

Frequently Asked Questions about fec-doc-sync

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

FAQPage Schema
How do I keep frontend project documentation in sync with code changes?

To keep frontend documentation in sync with code, you can automatically gather facts from package.json, lockfiles, routes, and framework configs, then diff them against existing README, ADR, and changelog files to update only stable, public-facing content.

Why does my README and ADR documentation drift from the actual project configuration?

Documentation drifts from actual project configuration when facts are updated manually. Synchronizing documentation directly from source code, .env.example, and framework configs ensures the README, ADRs, and changelogs accurately reflect the current state.

Can I sync documentation across multiple languages for the same frontend project?

Yes, you can sync documentation across multiple languages for the same frontend project. The synchronization process ensures the main language documentation and other language versions remain consistent after gathering deterministic facts from the codebase.

What is the best way to automatically update a changelog from lockfiles and routes?

The best way to automatically update a changelog from lockfiles and routes is to perform deterministic fact gathering from these source files, carefully diff the findings against existing documents, and update only the stable, public-facing entries.

What documentation sources are required to sync frontend docs from code?

To sync frontend docs from code, the required documentation sources include package.json, lockfiles, framework configs, .env.example, routes, API clients, architecture docs, and existing entry points like README, docs, ADRs, and changelogs.

Does frontend documentation sync work for projects with multiple README and docs entry points?

Frontend documentation sync is specifically designed for projects with multiple documentation entry points such as README, docs, and ADRs. It gathers facts from code and configuration to carefully diff and update stable, public-facing documents.