doc-check

Detect Markdown documents affected by code changes using dependency graphs.

1|Updated Sep 8, 2023

Search Tags:#documentation #markdown #workflow-automation #code-review #dependency-graph #change-detection

Ready to run

npx skills add https://github.com/cmb-sy/dotfiles --skill doc-check

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-check
Source: https://github.com/cmb-sy/dotfiles/tree/main/claude/skills/doc-check
Command: npx skills add https://github.com/cmb-sy/dotfiles --skill doc-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

コード変更により影響を受ける md ドキュメントを検出し、ユーザー承認後に更新を適用するプロセスを支援します。

Core Features & Use Cases

YAML frontmatter の depends-on に宣言されたファイルパスや glob を基に影響範囲を算出します。
本文中の Markdown リンクから依存グラフを構築し、git diff との突合で影響を特定します。
/doc-check から起動、あるいはコード変更を含むタスク完了時に実行を検討します。

Quick Start

Run the script from the skill directory to detect impacted Markdown documents and prompt for updates.

Frequently Asked Questions about doc-check

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

FAQPage Schema

How do I detect Markdown documentation affected by code changes?▼

Markdown documentation affected by code changes is detected by reading YAML frontmatter depends-on declarations and Markdown links to build a dependency graph, then matching it against git diff output to identify impacted files.

How does depends-on frontmatter work for documentation dependency tracking?▼

The depends-on frontmatter tracks documentation dependencies by accepting declared file paths or globs, which are parsed to calculate the impact scope when code files change, ensuring documentation stays synchronized with code modifications.

What is the best way to keep Markdown docs in sync with code changes during development?▼

Keeping Markdown docs in sync with code changes is handled by a script that builds a dependency graph from frontmatter and links, detects impacted documents via git diff, and prompts for user-approved updates with diffs.

Do I need to manually approve documentation updates detected through change tracking?▼

Manual approval is required for documentation updates detected through change tracking, as the workflow provides a user-driven update flow that presents diffs for review before applying any modifications to impacted Markdown files.

Can I use Markdown links to build a dependency graph for change detection?▼

Markdown links are used to construct a dependency graph for change detection by extracting link references from the document body and cross-referencing them with git diff to pinpoint which documentation requires updates.

When should I run documentation impact detection in a software development workflow?▼

Documentation impact detection should be run after completing tasks that include code changes or by launching it directly, ensuring that Markdown files accompanying code modifications are identified and updated before finalizing the workflow.