documentation
Claude Code documentation 安装:写 README、运行手册和架构记录
EnglishClaude Code 安装步骤
- 打开来源文档,从固定提交下载仓库快照。把 skills/documentation/ 整个目录复制到练习项目的 .claude/skills/documentation/。
- 检查 .claude/skills/documentation/SKILL.md 位于技能目录第一层。从练习项目根目录打开 Claude Code,在输入框键入 /documentation 开始试用。
中文摘要
AWS Samples 的 documentation 技能为 README、API 文档、运行手册和架构决策记录提供写作结构。重点是让命令、参数、响应和排查步骤能回到项目核对。
SKILL.md 中文导读
可复现示例
在练习目录创建一个简单的 package.json,设置 start 为 node server.js。让 server.js 监听 3000 端口,并为 /health 返回 200。调用 /documentation,只根据文件起草 Quick Start 和健康检查说明。工作步骤
- 确认真实启动命令、端口和健康检查路由。
- 按读者操作顺序写 README,并标明命令来自哪个项目文件。
- 逐项核对生成说明是否包含未经项目确认的依赖或部署步骤。
验收方法
得到可核验的启动说明和 /health 检查,写明 3000 端口及期望的 HTTP 200。内容只使用样例文件能够支持的信息。
GitHub 原文 · 更新日期
适用环境
用 Claude Code 在本地练习项目内验证。写最小 README 可只读本地文件。原文还列出 AWS 与第三方工具,可按任务需求另外配置。
常见问题
起草项目 README 一定要接入 AWS 插件吗?
写本地启动与用法说明时,可直接读取项目文件。写 AWS 服务配置或部署说明时,可以按原文列出的工具进一步核对官方文档。