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