document-sync

Solid

文档同步规范 — 代码变更后同步必查与条件文档

AI & Automation 263 stars 34 forks Updated 2 days ago AGPL-3.0

Install

View on GitHub

Quality Score: 84/100

Stars 20%
81
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Document Sync Skill ## 职责 在 dev/fix 工作流执行完成后,确保以下核心文档与代码变更保持同步: | 文档 | 同步级别 | 同步内容 | |------|:--------:|---------| | `changelogs/unreleased.md` | 🔴 必查 | 用户未明确要求发版时的未发布实现变更记录 | | `changelogs/README.md` | 🟡 条件 | changelog 目录结构或发布归档路径变化时同步说明 | | `CHANGELOG.md` | 🟡 条件 | 仅正式发版时更新已发布版本索引 | | `README.md` | 🔴 必查 | 安装/使用/API 说明与代码一致 | | `05-实施进度.md` | 🟡 条件 | 多批次、预计 ≥10 文件、跨轮次、阻塞或用户要求持续跟踪的任务必须更新当前批次状态 | | `.env.example` | 🟡 条件 | 用户 / 项目明确选择共享环境变量方案,或已有共享环境变量发生新增/修改/删除时同步更新示例文件;未指定 env 时不得主动把明文或硬编码改成 `.env.example`、`.env.local`、`.env.test.local`、`*Env`、secretRef 或 secret manager | | `.devcodex/profile/README.md` / `01-项目信息.md` / `02-架构约束.md` / `03-代码风格.md` | 🟡 条件 | 命中 `ProfileImpactCheck` 时同步;包括技术栈、框架/SDK、依赖管理、目录/模块边界、脚本/测试/发布路线、分发面、配置项、长期连接、`config.local.json` schema 或当前阶段变化 | | `RULES.md` | 🟡 条件 | 当入口路由、工作流说明、当前可用状态或使用方式变更时同步 | | `website/docs/guide/*.md` | 🟡 条件 | 当面向**使用者**的流程指南变更时同步(`audience=public-user`) | | `website/docs/**/contributing*` / `docs/dev/**` / maintainer 分区 | 🟡 条件 | 当**维护者**开发/贡献/发版文档变更时同步(`audience=maintainer-dev`) | | `website/docs/specs/*.md` | 🟡 条件 | 当永久规范页中的当前行为、流程图、规则说明变更时同步 | | website sidebar/nav / README 索引 / 目录页 | 🟡 条件 | 当正文定义阅读顺序、审查顺序、实施顺序或“先看什么”时,同批校验导航、sidebar 与索引页是否按同一顺序呈现;**跨受众导航变更须两边各验** | | `DocsConsumerSweep` | 🟡 条件 | 文档新增/调整命令、配置项、字段、状态、路径、能力承诺、阅读顺序或用户路径时,扫描 README / website / Profile / prompts / templates / examples / nav/sidebar / validate probes / 部署副本与代码消费位置 | | `website/docs/versions/v1/<active-version>/requirements/**` | 🟡 ...

Details

Author
devcodex-labs
Repository
devcodex-labs/devcodex
Created
5 months ago
Last Updated
2 days ago
Language
JavaScript
License
AGPL-3.0

Similar Skills

Semantically similar based on skill content — not just same category