Api Design Doc
PassAudited by ClawScan on May 1, 2026.
Overview
This is a coherent instruction-only API documentation helper; the only notable behavior is a scoped file write to a fixed document path.
This skill appears safe for normal use as an API documentation generator. Install it if you are comfortable with the agent creating or updating doc/API接口设计文档.md in your project, and review the generated file before using it as an implementation contract.
Findings (1)
Artifact-based informational review of SKILL.md, metadata, install specs, static scan signals, and capability signals. ClawScan does not execute the skill or run runtime probes.
Using the skill may create or update a documentation file under doc/ in the current project.
The skill asks the agent to create a directory and write a fixed Markdown document in the project. This is purpose-aligned and scoped, but users should be aware it can modify the project workspace.
仅生成一份API文档,保存在项目根目录下的 `doc/` 目录。若 `doc/` 目录不存在,应自动创建该目录后再写入文档。文档文件名固定为:`API接口设计文档.md`
Before running it, confirm the target project is correct and check whether doc/API接口设计文档.md already exists if you want to avoid overwriting prior work.
