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

​
入门

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

​
CLAUDE.md 模板

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

## 协作方式
- 你可以对想法提出质疑——这有助于产出更好的文档。这样做时请注明来源并解释你的理由
- 一定要先请求澄清，而不是主观臆断
- 绝不要撒谎、猜测或编造信息

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

## 内容策略
- 只记录足以让用户成功的信息——不多也不少
- 优先确保信息的准确性与可用性
- 尽可能让内容保持常青
- 在添加新内容前先搜索现有信息。避免重复，除非出于明确的战略目的
- 检查并遵循现有模式以保持一致性
- 从最小且合理的改动开始

## 文档配置文件

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

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

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

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

## 禁止事项
- 任何 MDX 文件都不得省略 frontmatter
- 内部链接不得使用绝对 URL
- 不要包含未测试的代码示例
- 不要主观臆断——务必先请求澄清

​
示例提示

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

​
将笔记转换为完善文档

把草稿整理为包含组件和前置信息的规范 Markdown 页面。 示例提示：
换行
将此文本转换为格式规范的 MDX 页面：[在此粘贴你的文本]

​
审查文档的一致性

获取有关改进风格、格式和组件使用的建议。 示例提示：
自动换行
审核 docs/ 目录中的文件，并提出提升一致性与清晰度的建议

​
功能变更时更新文档

随着产品演进，及时保持文档最新。 示例提示：
换行
我们的 API 现在需要提供一个版本参数。请更新我们的文档，在所有示例中添加 version=2024-01

​
生成全面的代码示例

创建包含错误处理的多语言示例。 示例提示：
换行
为[你的 API 端点]创建包含错误处理的 JavaScript、Python 和 cURL 代码示例

​
扩展 Claude Code

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

​
使用 GitHub Actions 实现自动化

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

​
多实例工作流

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

​
团队协作

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

​
自定义命令

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