← Back to Skills Marketplace
bovinphang

Doc Sync

by Bovin Phang · GitHub ↗ · v2.5.0 · MIT-0
cross-platform ✓ Security Clean
34
Downloads
0
Stars
1
Active Installs
1
Versions
Install in OpenClaw
/install fec-doc-sync
Description
Use when synchronizing frontend project documentation with source-of-truth files such as package.json, lockfiles, config, env examples, routes, API clients o...
README (SKILL.md)

文档同步

Purpose

从代码、配置、测试、类型、脚本和运行时模板同步前端项目文档,避免 README、docs、环境变量说明、API/路由说明、架构决策和迁移说明与实际项目行为漂移。

Procedure

  1. 识别项目栈、文档入口和本次需要同步的范围。
  2. 收集事实来源:package.json、lockfile、框架和构建配置、.env.example、路由、API clients 或 server routes、types/schemas、组件、测试、CI、build/deploy config。
  3. 比对 README、docs、ADR、changelog、example prompts、setup/deploy/env docs 中的命令、环境变量、路由、API 行为、部署步骤和支持矩阵。
  4. 只更新稳定的公共约定;不要把临时调试结论、一次性报告或未落地设计写入长期文档。
  5. 若仓库已有多语言文档,同步关键事实、命令名、环境变量、路由/API 名称和版本约束。
  6. 当目标仓库本身是 skill/agent/command 分发仓库时,再同步能力表、metadata、runtime docs 和 marketplace 描述。
  7. 运行相关文档一致性、类型检查、测试、构建或打包检查。

Constraints

  • 不把 README 变成完整实现细节;公开文档保留高信号摘要。
  • 不引入与事实来源不一致的命令、路径、环境变量、API 行为或能力名称。
  • 不把未确认的 TODO、草案或实验能力写成已支持行为。
  • 不修改用户项目私有文档,除非用户明确指定。
  • 多语言文档若无法完整翻译,至少保持命令名、环境变量、路由/API 名称、版本约束和报告格式一致。
  • 不把 ADR 当作长篇复盘;只记录背景、决策、取舍、影响范围、验证和回滚线索。

Expected Output

  • 列出已同步的 README/docs/ADR/changelog/env/setup/deploy 文档。
  • 总结使用的事实来源、更新范围、验证命令和未覆盖风险。
  • 标出仍需人工确认的产品文案、翻译、外部服务配置或发布说明。
Usage Guidance
This skill is appropriate to install for documentation maintenance. Expect it to read project files and propose or make documentation updates; review generated changes before committing, especially if your repository has private internal docs or release notes.
Capability Assessment
Purpose & Capability
The skill is for synchronizing frontend documentation with source-of-truth project files such as package manifests, configs, routes, APIs, tests, CI, and deployment docs; that capability is coherent with its metadata and README.
Instruction Scope
It directs the agent to inspect a broad but expected set of repository files and update documentation; it also limits scope by warning not to modify private project docs unless the user explicitly specifies them.
Install Mechanism
The artifact contains only markdown and JSON files, with no executable scripts, install hooks, or dependency execution path.
Credentials
No environment variables, credentials, network calls, or privileged system access are requested; references to .env.example are for documentation consistency.
Persistence & Privilege
No background workers, persistence mechanisms, privilege escalation, credential stores, or long-running processes are present.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install fec-doc-sync
  3. After installation, invoke the skill by name or use /fec-doc-sync
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v2.5.0
- Improved documentation with detailed purpose, procedure, and constraints for documentation synchronization. - Clarified supported use cases and scope, including specific file types and documentation types. - Added explicit non-goals and caveats for what not to sync or update. - Strengthened guidelines on multi-language documentation and fact-based updates. - Outlined expected outputs, including risk summaries and required manual confirmations.
Metadata
Slug fec-doc-sync
Version 2.5.0
License MIT-0
All-time Installs 1
Active Installs 1
Total Versions 1
Frequently Asked Questions

What is Doc Sync?

Use when synchronizing frontend project documentation with source-of-truth files such as package.json, lockfiles, config, env examples, routes, API clients o... It is an AI Agent Skill for Claude Code / OpenClaw, with 34 downloads so far.

How do I install Doc Sync?

Run "/install fec-doc-sync" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Doc Sync free?

Yes, Doc Sync is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does Doc Sync support?

Doc Sync is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created Doc Sync?

It is built and maintained by Bovin Phang (@bovinphang); the current version is v2.5.0.

💬 Comments