跳到正文
cccskills
免费在 GitHub 公开

codex-docs-change-sync

Use when code changes may require documentation updates; maps git diff to candidate docs without auto-editing documentation.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(5)

  • SKILL.md1.6 KB
  • agents/openai.yaml228 B
  • references/docs-sync-spec.md1.1 KB
  • references/mapping-rules.md1.1 KB
  • scripts/map_changes_to_docs.py14.8 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

TL;DR

Map code changes to affected documentation via map_changes_to_docs.py. Report-only by default, no auto-edit. Scope: auto-detect staged -> unstaged -> last commit. Fallback: manual diff inspection.

Codex Docs Change Sync

Purpose

Identify documentation that is likely affected by code changes.

Activation

  1. Activate during workflow docs steps.
  2. Activate on explicit $codex-docs-change-sync.

Script Invocation

  • Use map_changes_to_docs.py for report-only docs impact mapping.
  • See skills/.system/REGISTRY.md for full script paths.

Script Invocation Discipline

  1. Always run --help before invoking map_changes_to_docs.py.
  2. Treat the script as a black-box mapper and prefer direct execution over source inspection.
  3. Read script source only when customization or bug fixing is required.

Enhanced Diff Scope

If scope is not specified, use auto mode:

  1. staged changes
  2. unstaged changes
  3. last commit

Report which scope was selected.

Behavior

  1. Run script and parse JSON output.
  2. Report changed files and candidate docs with reason/confidence.
  3. Keep MVP in report-only mode; do not auto-edit docs unless user requests it.

Fallback

If script cannot run, inspect diffs manually and report likely docs: docs/, README.md, CHANGELOG.md, and module-specific docs.

Reference Files

  • references/docs-sync-spec.md: script behavior, output format, and fallback protocol.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Use when implementation is complete, all tests pass, and you need to decide how to integrate the work — guides completion of development work by presenting structured options for merge, PR, or cleanup

中文简介正在准备中。当前显示原文说明。

Bang-isme/CodexAI---Skills102026年10月5日 更新

Use when a project has 50+ files, missing context, or explicit $codex-genome request; generates multi-layer project context to reduce hallucination.

中文简介正在准备中。当前显示原文说明。

Bang-isme/CodexAI---Skills102026年10月5日 更新

Use for DESIGN.md visual identity contracts; author, scaffold, lint, diff, and export design contracts with the upstream spec and CLI.

中文简介正在准备中。当前显示原文说明。

Bang-isme/CodexAI---Skills102026年10月5日 更新

Use when the task involves reading, creating, or editing `.docx` documents, especially when formatting or layout fidelity matters; prefer `python-docx` plus the bundled `scripts/render_docx.py` for visual checks.

中文简介正在准备中。当前显示原文说明。

Bang-isme/CodexAI---Skills102026年10月5日 更新

Use for documents, reports, memos, guides, academic papers, or formal text that needs clear structure, reliable tone, formatting, and diagrams.

中文简介正在准备中。当前显示原文说明。

Bang-isme/CodexAI---Skills102026年10月5日 更新

Use when frontend, backend, mobile, data, DevOps, or security work needs domain routing and at most four focused references.

中文简介正在准备中。当前显示原文说明。

Bang-isme/CodexAI---Skills102026年10月5日 更新

查看 Bang-isme 的全部技能

报告此技能的问题