推荐语
告别手动写文档的烦恼！Claude Code Agent 让代码与文档同步更新，彻底解放开发者双手。
核心内容：
1. 如何快速搭建 Docusaurus 文档站点
2. Claude Code Agent 自动生成文档的四大核心功能
3. 典型文档结构与自动化更新触发方式
杨芳贤
53AI创始人/腾讯云(TVP)最具价值专家
写代码的人都知道，最讨厌的一件事情就是别人没有提供文档。第二讨厌的事情，是要自己写文档。
现在有了 Claude Code 之后，这些都不是事了，使用Claude Code Agent实现自动化文档，代码写完文档就自动端上来！
在你的项目中创建 Docusaurus 文档站点：
npx create-docusaurus@latest my-docs classic
当然，要执行这条命令，必须提前安装好Node的环境。
按照 CLI 提示完成安装步骤。你可以选择 JavaScript 或 TypeScript，根据个人偏好决定。
启动文档站点
然后打开 localhost:3000，你就能看到默认的 Docusaurus 文档站点已经准备就绪。
如果你没有任何的部署主机、VPS 之类的，又想分享给别人观看，那可以参照这个文章赛博菩萨系列：Claude Code/Codex远程内网穿透实现远程内容穿透，将文档分享给别人，完全免费，还可以省略购买服务器的费用。
来到我们的项目根目录，执行以下命令：
npx claude-code-templates@latest --agent=documentation/docusaurus-expert --yes
这条命令会自动在项目的根目录下创建项目级别的 .claude 的配置文件，并且自动安装文档agent。
Docusaurus文档agent会主动介入站点配置、内容管理，因为本身是开源的、可配置的，所以也可以完成 主题定制、构建排错与部署全流程。
安装完成后安装完成后，文档agent以下能力：
- 智能分析： 自动分析 Git 暂存的代码变更
- 内容识别： 识别需要更新文档的功能点
- 自动生成： 生成或修改对应的 Markdown 文档文件
- 结构维护： 保持现有文档结构和风格一致性
要生成文档可以使用下面的提示词
使用 docusuarus-expert 代理清理 @docs/ 中的所有默认 Docusaurus 文件，并生成添加我的项目文档的计划。
每当添加新功能或修改现有代码后，可以通过以下方式触发文档更新：
使用 Docusaurus-Expert 代理清理 @docs/ 中的所有默认 Docusaurus 文件，并生成添加您项目文档的计划。
典型的 Docusaurus 文档结构：
docs/
├── getting-started.md
├── features/
│ ├── feature1.md
│ ├── feature2.md
│ └── advanced.md
├── api/
│ ├── overview.md
│ └── reference.md
└── guides/
├── installation.md
└── configuration.md
其实就是生成一个具体的说明 Markdown 文件。
但是不需要任何的Markdown查看器了，它是通过一个网页形式将所有的文件进行有序号的组织，而且支持各类图表的渲染以及分层结构的展示。
粤ICP备14082021号
免费POC，
零成本试错
