Claude Code 是一款具备代理能力的命令行工具，可帮助你维护文档。它可以生成新内容、审阅现有页面，并让文档保持最新。 你可以在项目中添加 CLAUDE.md 文件并持续完善，从而训练 Claude Code 理解你的文档规范和工作流程。

​
入门

前提条件：
  • 有效的 Claude 订阅（Pro、Max 或 API 访问权限）
设置：
  1. 安装 Claude Code：
  npm install -g @anthropic-ai/claude-code
  1. 进入你的文档目录。 3.（可选）将下方的 CLAUDE.md 文件添加到你的项目中。
  2. 运行 claude 开始使用。
  3. 按照提示完成初始配置（如有需要）。

​
CLAUDE.md 模板

在文档目录的根目录保存一个名为 CLAUDE.md 的文件，以帮助 Claude Code 理解你的项目。此文件会让 Claude Code 学习你的文档规范、偏好和工作流程。更多信息请参见 Anthropic 文档中的管理 Claude 的记忆。 复制此示例模板，或根据你的文档规范进行修改： 
# Mintlify 文档

## 协作方式
- 你可以对想法提出反对意见——这有助于产出更好的文档。这样做时请引用来源并解释你的理由
- 始终先寻求澄清，而不是作出假设
- 绝不要撒谎、猜测或编造信息

## 项目背景
- 格式：带有 YAML frontmatter 的 MDX 文件
- 配置：用于导航、主题和设置的 docs.json
- 组件：Mintlify 组件

## 内容策略
- 记录恰到好处的信息以确保用户成功——不多也少
- 优先保证信息的准确性和可用性
- 尽可能让内容常青
- 在添加新内容之前先搜索现有信息。除非基于明确策略，否则避免重复
- 检查既有模式以确保一致性
- 从最小且合理的改动开始

## docs.json

- 构建 docs.json 文件和站点导航时参考 [docs.json schema](https://mintlify.com/docs.json)

## 页面 frontmatter 要求
- title：清晰、具描述性的页面标题
- description：用于 SEO/导航的简洁摘要

## 写作规范
- 使用第二人称（“you”）
- 在流程性内容开头列出先决条件
- 在发布前测试所有代码示例
- 与现有页面的风格和格式保持一致
- 同时包含基础和高级用例
- 为所有代码块添加语言标签
- 为所有图片添加替代文本（alt）
- 内部链接使用相对路径

## Git 工作流
- 提交时绝不要使用 --no-verify
- 开始之前先询问如何处理未提交的更改
- 当没有明确可用分支时创建新分支
- 在开发过程中频繁提交
- 绝不要跳过或禁用 pre-commit 钩子

## 禁止事项
- 不得在任何 MDX 文件中省略 frontmatter
- 内部链接不得使用绝对 URL
- 不得包含未经测试的代码示例
- 不要作出假设——始终先寻求澄清

​
示例提示

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

​
将笔记转换为完善的文档

将初稿打磨为包含组件和 frontmatter 的规范 Markdown 页面。 示例提示： 
Convert this text into a properly formatted MDX page: [paste your text here]

​
审阅文档以确保一致性

获取关于改进写作风格、格式和组件用法的建议。 示例提示： 
Review the files in docs/ and suggest improvements for consistency and clarity

​
功能变更时更新文档

在产品迭代时保持文档最新。 示例提示： 
Our API now requires a version parameter. Update our docs to include version=2024-01 in all examples

​
生成完整的代码示例

创建包含错误处理的多语言示例。 示例提示： 
Create code examples for [your API endpoint] in JavaScript, Python, and cURL with error handling

​
扩展 Claude Code

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

​
使用 GitHub Actions 实现自动化

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

​
多实例工作流

针对不同任务分别使用独立的 Claude Code 会话——一个用于撰写新内容，另一个用于审阅与质量把控。这样有助于保持一致性，并捕捉单一会话可能忽略的问题。

​
团队协作

将你完善的 CLAUDE.md 文件分享给团队，确保所有贡献者遵循一致的文档标准。团队通常会制定针对项目的提示和工作流程，并将其纳入文档体系。

​
自定义命令

在 .claude/commands/ 中创建可复用的斜杠命令，用于你的项目或团队特有的常用文档任务。