Skip to main content
Claude Code 是一款具备智能体能力的命令行工具,可帮助你维护文档。它能够撰写新内容、评审现有页面,并保持文档持续更新。 你可以在项目中添加一个 CLAUDE.md 文件,并随着时间迭代完善,以训练 Claude Code 理解你的文档规范和工作流程。

入门

前提条件:
  • 有效的 Claude 订阅(Pro、Max 或 API 访问权限)
设置:
  1. 安装 Claude Code:
  1. 进入文档目录。
  2. (可选)将下方的 CLAUDE.md 文件添加到项目中。
  3. 运行 claude 即可开始。

CLAUDE.md 模板

在文档目录的根目录保存一个 CLAUDE.md 文件,帮助 Claude Code 理解你的项目。该文件会让 Claude Code 了解你的文档规范、偏好和工作流程。更多信息请参见 Anthropic 文档的 Manage Claude’s memory 复制以下示例模板,或根据你的文档规范进行调整:

示例提示

完成 Claude Code 的设置后,尝试以下提示,看看它如何帮助处理常见的文档任务。你可以直接复制并粘贴这些示例,或根据你的具体需求进行调整。

将笔记转换为完善文档

把草稿整理为包含组件和前置信息的规范 Markdown 页面。 示例提示:
换行

审查文档的一致性

获取有关改进风格、格式和组件使用的建议。 示例提示:
自动换行

功能变更时更新文档

随着产品演进,及时保持文档最新。 示例提示:
换行

生成全面的代码示例

创建包含错误处理的多语言示例。 示例提示:
换行

扩展 Claude Code

除了手动与 Claude Code 交互,你还可以将其集成到现有工作流中。

使用 GitHub Actions 实现自动化

在代码变更时自动运行 Claude Code,保持文档实时更新。你可以在拉取请求上触发文档审查,或在检测到 API 变更时自动更新示例。

多实例工作流

为不同任务使用独立的 Claude Code 会话——一个用于撰写新内容,另一个用于审阅与质量保证。这样有助于保持一致性,并捕捉单个会话可能遗漏的问题。

团队协作

将完善后的 CLAUDE.md 文件与团队共享,确保所有贡献者遵循一致的文档标准。团队通常会制定项目专用的提示词和工作流,并将其纳入文档流程。

自定义命令

.claude/commands/ 中创建可复用的斜杠命令,用于处理你的项目或团队中高频的文档任务。