← 返回 Skills 市场

Ensure Docs

Name: Ensure Docs
Author: anderskev

作者 Kevin Anderson · GitHub ↗ · v1.0.1 · MIT-0

cross-platform ⚠ suspicious

139

总下载

当前安装

版本数

在 OpenClaw 中安装

/install ensure-docs

功能描述

Verify documentation coverage and generate missing docs interactively

使用说明 (SKILL.md)

Ensure Documentation Coverage

Verify documentation coverage across a codebase, report gaps, and generate missing docs with parallel language-specific agents.

Workflow

Complete steps in order. Do not advance until each step’s Pass is satisfied.

Language detection — Follow Phase 1 (language detection) in references/workflow.md.
- Pass: For each language you will verify, you have evidence of at least one matching source file (counts or command output); if none qualify, stop with a short “no applicable languages” message and do not spawn verifiers.
Load standards — Read the sections for your detected languages (language standards, verifier prompts, consolidation format) in the same reference file.
- Pass: You can state which standard applies per language (e.g. Google docstrings, JSDoc, GoDoc) before spawning agents.
Parallel verification — Spawn one verifier per qualifying language using the agent prompts and JSON output shape in the reference (Phase 2).
- Pass: Each completed agent returns parseable JSON including language, files_scanned, and findings (array, possibly empty).
Consolidated report — Merge results per Phase 3 (summary table, severity grouping, detailed findings if requested).
- Pass: The user sees the merged report (inline or written to an agreed path) before you claim the audit is done or propose fixes.
Generation — Only if --report-only is not set: offer choices per Phase 4; apply doc edits only after an explicit user choice to generate.
- Pass: No documentation edits for gaps until the user selects an option that includes generation; if they decline or choose report-only behavior, end after the report.
Post-edit verification — After any generation, run or offer the linter commands in Phase 5 of the reference for languages you changed, when those tools exist in the repo.
- Pass: Linter run completed with output captured, or N/A with a one-line reason (e.g. tool not configured); remaining issues are listed or cleared.

Notes

Use --report-only to skip generation.
Avoid test files unless they are test helpers.
Keep report output aligned with the language-specific standards in the reference file.

安全使用建议

The skill's behavior mostly matches its description, but it contains a critical contradiction: disable-model-invocation is set true while the workflow requires spawning Task-based subagents and asking interactive questions (which need model invocation). Before installing: 1) Ask the publisher to clarify/fix the disable-model-invocation setting — as-is the skill will likely be non-functional. 2) Confirm your platform provides the Task tool (subagent capability) and that you trust it to inspect the repository. 3) Run the skill in --report-only mode first (no automatic edits) and test on a non-sensitive repository. 4) Only allow generation (edits) after reviewing the proposed changes; the skill's docs state edits should only proceed after explicit user choice, but verify this behavior in practice.

功能分析

Type: OpenClaw Skill Name: ensure-docs Version: 1.0.1 The ensure-docs skill is a documentation auditing and generation tool that automates the verification of docstring compliance for Python, TypeScript, and Go. It uses standard shell commands (find, grep) for language detection and spawns sub-agents to analyze code and generate missing documentation interactively. The workflow is well-documented in SKILL.md and references/workflow.md, utilizing standard development tools like ruff, eslint, and staticcheck for post-generation verification without any signs of malicious intent or data exfiltration.

能力评估

✓ Purpose & Capability

The name/description ('Verify documentation coverage and generate missing docs') align with the instructions: detect languages, run codebase scans, consolidate findings, and optionally generate docs. The file-scanning, standards, and generation steps are coherent for this purpose.

⚠ Instruction Scope

The SKILL.md header and registry metadata set disable-model-invocation: true, but the workflow repeatedly instructs spawning verification and generation subagents via the Task tool (and using AskUserQuestion) which require model invocation. This is a direct contradiction: either the skill will be unable to perform its described agent-spawning behavior, or the metadata is wrong. The instructions also call standard shell tools (find, grep) to read the repository — that is expected for this purpose but assumes typical shell availability.

✓ Install Mechanism

Instruction-only skill with no install spec and no code to write to disk. This is the lowest-risk install profile.

✓ Credentials

The skill declares no required environment variables, no credentials, and no config paths. The actions described (scanning repo files, optionally running linters present in the repo) are proportionate to the stated purpose.

✓ Persistence & Privilege

Skill is not always-on, does not request elevated persistence, and does not modify other skills' configs. It does instruct spawning subagents for parallel verification, which is expected for the task.

如何使用

确保已安装 OpenClaw（本地或 Docker 部署）
在对话框中输入安装命令：/install ensure-docs
安装完成后，直接呼叫该 Skill 的名称或使用 /ensure-docs 触发
根据 Skill 的参数说明提供必要输入，即可获得结构化输出

版本历史

v1.0.1

- Expanded and clarified the workflow steps for verifying and generating documentation. - Added explicit "Pass" criteria for each workflow step, detailing required evidence and conditions before advancing. - Included requirements for language standards identification and agent output validation. - Mandated user confirmation before generating any documentation, and clarified behavior for `--report-only`. - Specified post-edit linter verification, including guidance on handling missing or unavailable tools.

v1.0.0

Initial release of ensure-docs: - Verifies documentation coverage across a codebase for multiple languages. - Detects languages, analyzes docs, and reports gaps. - Offers interactive generation of missing documentation where needed. - Consolidates findings into a single, standards-aligned report. - Excludes regular test files from coverage. - Includes option to report only, without generating docs.

元数据

Slug ensure-docs

版本 1.0.1

许可证 MIT-0

累计安装 1

当前安装数 1

历史版本数 2

常见问题

Ensure Docs 是什么？

Verify documentation coverage and generate missing docs interactively. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 139 次。

如何安装 Ensure Docs？

在 OpenClaw 或 Claude Code 对话框中运行命令「/install ensure-docs」即可一键安装，无需额外配置。

Ensure Docs 是免费的吗？

是的，Ensure Docs 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。

Ensure Docs 支持哪些平台？

Ensure Docs 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。

谁开发了 Ensure Docs？

由 Kevin Anderson（@anderskev）开发并维护，当前版本 v1.0.1。