使用Trae为Github项目编写中英双语文档

在AI编程领域，Cursor名字如雷贯耳，特别是受到广大开发人员的喜爱。不过Cursor Pro版每月20美元（150块钱）的价格，只有500次快速请求，似乎性价比不是很高。

近期有一款对标Cursor的AI编程工具 - Trae，这是由国内厂商字节出品的AI编程客户端，支持智能代码补全、多模态交互以及自动编码等功能，关键是免费。

使用Trae或Cursor等工具编写代码，是一个常规操作。今天介绍一下使用Trae编写中英双语文档。

扫码或微信搜索 agentfans 获取最新消息

正式开始前，先简单介绍一下Trae。

Trae简介

Trae的读音是/treɪ/。按照掘金社区的介绍，它是：

一款面向开发者的 AI 驱动的集成开发环境（IDE）。它通过智能代码补全、多模态交互以及对整个代码库的上下文分析等功能，帮助开发者更高效地编写代码。

Trae分为海外版和国内版：

• 海外版搭载了Claude Sonet 3.5及最新的3.7、GPT-4o以及DeepSeek R1模型。网站：trae.ai
• 国内版搭载了Doubao-1.5-Pro、DeepSeek R1/V3模型。网站：trae.com.cn

海外版已经发布一个多月了，国内版3月3日正式发布。下面介绍的编写中英双语文档案例中，我使用的是海外版Trae。

背景

我之前曾写过一个sdk，把代码放在了github上（不好意思叫开源），同时写了一份说明文件（README），为了显得有B格，我先写了中文文档，又用自己那蹩脚的英语给翻译成了英文。这样github项目主页上就有了中英双语文档。不过当时干这个事情感觉很吃力，一是写文档比较费时间、精力有限很多内容没有充分介绍，二是自己翻译的英文在语法、句式上可能不符合英文表达习惯，显得不地道。

既然现在AI这么强了，为什么不用AI帮我写文档并且翻译呢？说干就干。

因为之前用Cursor，我知道现在AI编程工具能够读懂整个代码库，并且能够将代码逻辑输出成文字，这正好符合我的场景，根据已有代码补充文档，而AI翻译更不在话下。

之前Cursor可以白嫖，免费用过一段时间，后来白嫖的口子被堵上了，就没怎么用了。现在有免费的Trae，不用白不用。以下就是我用Trae给已有项目编写中英双语文档的步骤。

下载安装

从Trae官网上下载并安装Trae，这个比较简单，不再啰嗦了。然后在Trae里面打开项目文件夹。

生成文档大纲

github上的项目文档一般使用markdown编写，并且可以通过github pages来托管。关于文档的内容组织，我希望让AI帮我初步规划一下，并考虑后续托管的便利性，所以先抛出一个笼统的问题（为了让过程更可控，我使用的是Chat模式而非Builder）：

我有一个XX项目，它是一个go语言sdk，代码已经完成，现在我需要你帮我生成项目文档。关于文档的内容、组织、格式、托管等，我想听听你的建议。

基本上解答了我的疑问，下一步，让它根据文档内容生成对应文件。

可以看到，Trae自动生成了文件名并提供了bash命令，点运行即可创建文件。继续。

以上用了三个指令让Trae生成了文档大纲和空文件。其实上述步骤可以简化一下，直接按以下指令让它生成文档大纲并创建文件即可。

我有一个XXX项目，它具有XX、XX、XX功能，需要你帮我生成中英双语项目文档以便在github上托管。请先生成文档大纲并创建相应目录和文件，只创建空文件即可，根据后续指令再补充完善文档内容。

又经过几次迭代后，最终的文档目录结构如下：

生成文档内容

生成文档大纲后，就是逐个文件补充文档内容了。

先从项目简介开始，由于项目里面有我之前手写的README文件，所以它参考README文件内容，简单组织下很快就完成了。

现在生成 introduction.md文档内容，英文文件位于doc/en/，中文文件位于doc/zh/

中文版没啥可说的，英文版反正比我自己翻译的好。

如果生成的内容不合适，还可以让它修改。

大纲里的其它文档内容也是按类似方式来生成，有的文档需要给它提供一些素材（比如大致内容描述）才能生成不错的内容，否则就只能泛泛而谈了。另外，文档需要用到一些流程图等，这个没法用AI生成，需要手画。

根据代码生成文档

简介之类的文档，用AI来生成相对比较容易，但是最有用的是根据代码来生成文档内容。例如项目中有我之前写的示例，所以我直接让Trae根据示例代码来生成“使用示例”文档。

根据 example.go 内容，仿照quickstart编写使用示例文档，包含中英文版本两个文件

看起来还可以，不过里面可能缺少一些关键的描述信息，引用的代码也不一定准确。这个需要补充必要信息后让它修改，或者自己手工修改。

控制输出格式

在生成文档内容过程中，发现有时输出的内容格式不符合预期。比如：

1. 只输出中文版、没有英文版，或者只有英文版没有中文版。
2. 在文档markdown中引入代码块时，会导致Trae输出的文档内容显示不连贯，如下面“Setting Up“本来应该是在markdown里面，却显示在quick_start.md外面了。这个原因是代码块前后被三个反引号```包围，而Trae输出的markdown也是用三个反引号包围，导致markdown在代码块后面提前截断。

这两个问题的解决方案也比较简单，就是每次在指令后面明确要求“输出中英文、对反引号转义”。如下图，可以看到markdown中三个反引号前面都加了反斜杠\，这个需要手工去掉，在文档上才能正常显示代码块。

文档托管到Github

所有文档内容都生成完后，需要托管到Github上，这个过程我也让Trae来辅助完成。

不仅给出了配置文件，也提供了操作步骤和命令，按照步骤执行就可以部署到Github上托管了。不过我按照它给的步骤执行的时候，遇到了一些错误，有的错误可以借助Trae来辅助解决，但也出现了它解决不了问题，反复循环尝试不同方案但都不能解决问题，这个时候就需要人来判断并干预了。

从实际体验来看，使用Trae这类工具来编写技术文档，能够大大提高效率，感觉比人工手写还是强多了，特别是在多语言文档输出方面帮助比较大。

 

扫码或微信搜索 agentfans 获取最新消息