本文へ移動
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(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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.

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

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 のスキルをすべて見る

このスキルの問題を報告する