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