← Back to Skills Marketplace
Doc Gap Finder
by
vx：17605205782
· GitHub ↗
· v1.0.0
· MIT-0
201
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install doc-gap-finder
Description
扫描文档目录、标题结构与文件分布，找缺失章节、重复内容和过时区域。；use for docs, audit, knowledge workflows；do not use for 读取无权限目录, 直接修改原文档.
README (SKILL.md)
文档缺口发现器
你是什么
你是“文档缺口发现器”这个独立 Skill，负责：扫描文档目录、标题结构与文件分布，找缺失章节、重复内容和过时区域。
Routing
适合使用的情况
- 扫描 docs 目录找缺口
- 帮我看哪些文档可能过期或重复
- 输入通常包含：文档目录或文件夹路径
- 优先产出：目录概览、疑似缺口、优先级
不适合使用的情况
- 不要用来读取无权限目录
- 不要直接修改原文档
- 如果用户想直接执行外部系统写入、发送、删除、发布、变更配置，先明确边界，再只给审阅版内容或 dry-run 方案。
工作规则
- 先把用户提供的信息重组成任务书，再输出结构化结果。
- 缺信息时，优先显式列出“待确认项”，而不是直接编造。
- 默认先给“可审阅草案”，再给“可执行清单”。
- 遇到高风险、隐私、权限或合规问题，必须加上边界说明。
- 如运行环境允许 shell / exec，可使用：
python3 "{baseDir}/scripts/run.py" --input \x3C输入文件> --output \x3C输出文件>
- 如当前环境不能执行脚本，仍要基于
{baseDir}/resources/template.md与{baseDir}/resources/spec.json的结构直接产出文本。
标准输出结构
请尽量按以下结构组织结果：
- 目录概览
- 疑似缺口
- 重复与近似章节
- 建议补写内容
- 建议删除内容
- 优先级
本地资源
- 规范文件：
{baseDir}/resources/spec.json - 输出模板：
{baseDir}/resources/template.md - 示例输入输出：
{baseDir}/examples/ - 冒烟测试：
{baseDir}/tests/smoke-test.md
安全边界
- 默认只读扫描，不会删除或改写文件。
- 默认只读、可审计、可回滚。
- 不执行高风险命令，不隐藏依赖，不伪造事实或结果。
Usage Guidance
This appears to be a coherent local, read-only documentation-audit skill. Before running: (1) run it against a limited test directory or use --dry-run to verify output, (2) avoid pointing it at system or production roots (e.g., /, home of other users, or repos containing secrets), (3) review outputs before sharing (the tool redacts obvious secret-like strings but you should still verify), and (4) prefer running in a least-privileged environment (separate container or workspace) when scanning unknown repositories.
Capability Analysis
Type: OpenClaw Skill
Name: doc-gap-finder
Version: 1.0.0
The 'doc-gap-finder' skill is a documentation auditing tool designed to scan directories for missing sections, duplicates, and potential security risks within a codebase. The core logic in 'scripts/run.py' performs read-only file system operations, extracting Markdown headings and scanning for patterns like hardcoded secrets or dangerous shell commands (e.g., 'curl|bash') to include in an audit report. It lacks network capabilities, obfuscation, or any mechanisms for data exfiltration, and its instructions in 'SKILL.md' explicitly define safe operational boundaries.
Capability Assessment
Purpose & Capability
Name/description (document gap finder) align with the provided files and the included scripts: the repo contains a template, spec.json, examples and a Python script that performs directory/csv/pattern/skill audits. Requiring only python3 is proportionate.
Instruction Scope
SKILL.md correctly instructs running the local script and also supports producing output from the bundled template when execution isn't possible. The script legitimately reads files under a supplied input directory and extracts headings and file lists. Caution: if given an arbitrary root path (e.g., /), the script will read many file types (.md, .py, .sh, .json, etc.) — which is expected for a directory audit but could expose sensitive files if the user supplies paths they don't own. The SKILL.md warns about not scanning unauthorized directories; that warning should be followed.
Install Mechanism
No install spec; this is instruction/script-based and only requires python3 on PATH. No network downloads or external package installs are present.
Credentials
The skill requests no environment variables or credentials. The script includes heuristics to detect secret-like patterns and redacts matched secret substrings in its findings (limiting accidental disclosure in output). There is no unexplained access to unrelated services.
Persistence & Privilege
Skill is not always-enabled and does not request persistent privileges or modify other skills/system configs. It is user-invocable and runs locally when invoked.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install doc-gap-finder - After installation, invoke the skill by name or use
/doc-gap-finder - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of doc-gap-finder.
- Scans document directories and analyzes heading structure and file distribution.
- Detects missing sections, duplicate content, and outdated areas in documentation.
- Generates structured reports with overview, suspected gaps, duplicates, and suggestions for additions or deletions.
- Read-only operation; does not directly modify existing documents.
- Emphasizes auditability, safety, and clearly defined boundaries.
Metadata
Frequently Asked Questions
What is Doc Gap Finder?
扫描文档目录、标题结构与文件分布，找缺失章节、重复内容和过时区域。；use for docs, audit, knowledge workflows；do not use for 读取无权限目录, 直接修改原文档. It is an AI Agent Skill for Claude Code / OpenClaw, with 201 downloads so far.
How do I install Doc Gap Finder?
Run "/install doc-gap-finder" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Doc Gap Finder free?
Yes, Doc Gap Finder is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Doc Gap Finder support?
Doc Gap Finder is cross-platform and runs anywhere OpenClaw / Claude Code is available (darwin, linux, win32).
Who created Doc Gap Finder?
It is built and maintained by vx：17605205782 (@52yuanchangxing); the current version is v1.0.0.
More Skills