关于 code-documentation-analyzer
用于技术文档工作的代码文档分析技能，可提供指导、生成代码和配置，并依据常见标准验证输出。
主要功能
- 01文档任务分步指导
- 02文档模式建议
- 03生成代码和配置
- 04验证输出
适用场景
- 01分析代码文档
- 02了解 API 文档实践
- 03生成文档配置
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/code-documentation-analyzer确认已加载。
详细介绍
代码文档分析器
概述
此技能可为技术文档领域中的代码文档分析器任务提供自动化辅助。
适用场景
在以下情况下，此技能会自动启用：
- 在请求中提及“代码文档分析器”
- 询问代码文档分析器的模式或最佳实践
- 需要技术文档技能方面的帮助，涉及 API 文档、用户指南、架构文档和文档自动化
说明
- 为代码文档分析器提供分步指导
- 遵循行业最佳实践和模式
- 生成可用于生产环境的代码和配置
- 根据通用标准验证输出
示例
示例：基本用法 请求：“帮我使用代码文档分析器” 结果：提供分步指导并生成合适的配置
前提条件
- 已配置相关开发环境
- 可访问必要的工具和服务
- 对技术文档概念有基本了解
输出
- 生成的配置和代码
- 最佳实践建议
- 验证结果
错误处理
| 错误 | 原因 | 解决方案 |
|---|---|---|
| 配置无效 | 缺少必填字段 | 查阅文档，了解必需参数 |
| 未找到工具 | 未安装依赖项 | 根据前提条件安装所需工具 |
| 权限被拒绝 | 访问权限不足 | 验证凭据和权限 |
资源
- 相关工具的官方文档
- 最佳实践指南
- 社区示例和教程
相关技能
属于技术文档技能类别。 标签：文档、markdown、api-docs、readme、技术写作
评论
支持 Markdown