Claude Code

配置 Claude Code，助你撰写、评审与更新文档

Claude Code 是一款具备代理能力的命令行工具，能帮助你维护文档。它可以撰写新内容、评审现有页面，并保持文档最新。

你可以在项目中添加一个 CLAUDE.md 文件，并持续迭代其内容，以训练 Claude Code 理解你的文档规范与工作流程。

​

快速开始

前提条件：

• 有效的 Claude 订阅（Pro、Max 或 API 访问权限）

设置：

1. 安装 Claude Code：

  npm install -g @anthropic-ai/claude-code

2. 进入您的文档目录。
3. （可选）将下面的 CLAUDE.md 文件添加到您的项目中。
4. 运行 claude 启动。

​

CLAUDE.md 模板

在文档目录根目录保存一个 CLAUDE.md 文件，帮助 Claude Code 理解你的项目。该文件会基于你的文档标准、偏好和工作流程对 Claude Code 进行训练。更多信息请参阅 Anthropic 文档中的管理 Claude 的记忆。

复制此示例模板，或根据你的文档规范进行调整：

# Mintlify 文档

## 工作关系
- 你可以对想法提出质疑——这有助于产出更好的文档。在这样做时，请引用资料来源并说明你的理由
- 务必要求澄清，而不是自行假设
- 绝不撒谎、猜测或编造任何内容

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

## 内容策略
- 记录恰到好处的内容以确保用户成功——不多不少
- 优先考虑准确性和可用性
- 尽可能让内容保持长期有效
- 在添加任何新内容之前先搜索现有内容。除非出于战略考虑，否则避免重复
- 检查现有模式以保持一致性
- 从最小合理的更改开始

## docs.json

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

## 页面的 frontmatter 要求
- title：清晰、描述性的页面标题
- description：用于 SEO（搜索引擎优化）/导航的简洁摘要

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

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

## 禁止事项
- 在任何 MDX 文件上跳过 frontmatter
- 对内部链接使用绝对 URL
- 包含未经测试的代码示例
- 自行假设——务必要求澄清

​

示例提示

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

​

将笔记转化为完善文档

把粗略草稿转为包含组件和 frontmatter 的规范 Markdown 页面。

示例提示：

将此文本转换为格式正确的 MDX 页面：[在此处粘贴您的文本]

​

审阅文档的一致性

获取关于改进样式、格式和组件使用的建议。

示例提示：

检查 docs/ 中的文件，并针对一致性和清晰度提出改进建议

​

功能变更时更新文档

在产品迭代中保持文档及时更新。

示例：

我们的 API 现在需要版本参数。请更新文档，在所有示例中包含 version=2024-01

​

生成完善的代码示例

创建包含错误处理的多语言示例。

示例提示：

为 [你的 API 端点] 创建包含错误处理的 JavaScript、Python 和 cURL 代码示例

​

扩展 Claude Code

除了手动向 Claude Code 提示外，你还可以将其集成到现有的工作流程中。

​

使用 GitHub Actions 实现自动化

在代码变更时自动运行 Claude Code，保持文档同步更新。你可以在拉取请求（PR；亦称“合并请求”/Merge Request）上触发文档审阅，或在检测到 API 变更时自动更新示例。

​

多实例工作流

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

​

团队协作

将优化后的 CLAUDE.md 文件与团队共享，确保所有贡献者遵循一致的文档标准。团队通常会形成项目特定的提示与工作流程，并将其纳入文档实践中。

​

自定义命令

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