文本描述或实现了文件修改
59 次命中此行包含可能的文件写入或重定向操作。应检查目标路径和覆盖行为;静态审查没有写入任何文件。 该规则在收集文本中命中 59 处;此处列出 3 个代表位置。命中文本可能只是文档,分析器没有执行它。
技能研究档案
Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.
Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.
Skill Atlas editorial review · editorial-preview-1.0.0
添加并验证技术文档,包括 docstring、JSDoc、OpenAPI 规范与使用指南,先询问格式偏好,并在汇报前测试示例。
对所收集的 SKILL.md 及辅助文本/代码进行确定性静态分析。机器辅助候选和发现等待人工编辑复核;不评估动态行为或效果。
文件清单来自记录提交中的采集源码。路径与大小属于结构观察,不代表质量评价。
skills/code-documenter/references/api-docs-fastapi-django.md引用4.1 KBskills/code-documenter/references/api-docs-nestjs-express.md引用4.8 KBskills/code-documenter/references/coverage-reports.md引用3 KBskills/code-documenter/references/documentation-systems.md引用6 KBskills/code-documenter/references/interactive-api-docs.md引用10 KBskills/code-documenter/references/python-docstrings.md引用2.9 KBskills/code-documenter/references/typescript-jsdoc.md引用3 KBskills/code-documenter/references/user-guides-tutorials.md引用10.7 KB{
"name": "code-documenter",
"description": "Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.",
"license": "MIT",
"metadata": {
"author": "https://github.com/Jeffallan",
"company": "https://synergetic.solutions",
"version": "1.1.0",
"domain": "quality",
"triggers": "documentation, docstrings, OpenAPI, Swagger, JSDoc, comments, API docs, tutorials, user guides, doc site",
"role": "specialist",
"scope": "implementation",
"output-format": "code",
"related-skills": "spec-miner, fullstack-guardian, code-reviewer"
}
}此工作流根据源码材料重建表面顺序。除非明确记录受控评估,否则它属于暂定解读,而非真实运行轨迹。
识别语言与框架后,找出未文档化的代码。
若验证失败,先修复示例并重新验证,再进入汇报步骤。
视任务交付已补全文档的文件与覆盖率报告、规范、文档站配置或指南。
静态发现用于提示安装前需要检查的位置,不能证明一项技能安全、恶意或有效。
收集的文本中有 93 项确定性词法发现需要复核。发现可能仅位于文档中,不证明已执行或可被利用;仅含二进制的文件未扫描。
此行包含可能的文件写入或重定向操作。应检查目标路径和覆盖行为;静态审查没有写入任何文件。 该规则在收集文本中命中 59 处;此处列出 3 个代表位置。命中文本可能只是文档,分析器没有执行它。
此源文件行包含 URL 或网络客户端。应检查目标地址、发送的数据和信任边界;静态文本无法证明实际发生了网络活动。 该规则在收集文本中命中 22 处;此处列出 3 个代表位置。命中文本可能只是文档,分析器没有执行它。
此行疑似凭据字面值,或读取敏感环境变量。请勿暴露其内容;应核实它是占位符、所需密钥,还是误提交的敏感材料。 该规则在收集文本中命中 12 处;此处列出 3 个代表位置。命中文本可能只是文档,分析器没有执行它。
检查文档示例与生成的规范中是否泄露真实密钥、内部网址或私有端点信息。
发现、激活与资源层具有不同含义。只有使用指定官方方法并记录模型的运行时,才显示精确数值。
在管线使用明确模型执行官方精确计数之前,包括文件清单在内的所有 token 值均为 null。
未使用要求的官方方法记录 token 测量。本档案不会用字符数、文件大小或估计值替代。
该技能仅具备以上标明的证据。不声称任何任务成功率、token 效率、延迟或质量优势。
git clone https://github.com/Jeffallan/claude-skills.git
cd claude-skills
# 将该 Skill 目录复制到以下任一位置:
# ~/.claude/skills/code-documenter
# .claude/skills/code-documenter确认目标位置存在 code-documenter/SKILL.md,然后让 Claude Code 在一个小型测试任务中使用 code-documenter Skill。
Use the code-documenter skill to add Google-style docstrings to the public functions in src/users.py, ask me about format first, and validate the examples with doctest.
Read the code-documenter skill at https://github.com/Jeffallan/claude-skills/blob/67c1961b180dc92cf08983344627109e983e8f51/skills/code-documenter/SKILL.md and its referenced files. Explain its workflow, required tools, permissions and the main risks before I decide whether to install it.
研究结论可靠的文档工作流,在示例可被编译或校验的场景中效果最好。
档案是对公开工件的限时阅读,而非背书。请通过来源链接检查确切的上游材料。
67c1961b180dc92cf08983344627109e983e8f51仅对提供的文件进行确定性词法解析、YAML frontmatter 校验、文件清单、来源描述的工作流程提取和启发式暂定分类。由机器生成;无 LLM、执行、动态测试或人工编辑批准。