如何写一个漂亮的技术文档

作为一个爱打比赛的同学，写文档的能力是必不可少的。那么本期我们就来教大家如何写下一个比较好的技术文档。

AI写作的常见问题

很多同学，包括我在内，都很喜欢用ai来写文档。但是没有任何提示词的情况下，ai很容易写出非常人机的文档。

我个人在使用过程中，发现ai写作经常有以下的问题:

• 在中文和英文、数字之间加入空格。
• 大量使用引号和分号，为了排比而排比。
• 使用先否定再肯定的表述形式，比如说“我们的项目不是....而是...”。
• 生硬的使用很多真人很少使用的词汇，比如说“全链路闭环机制”，当然如果是在政治等学科中另说。
• 说话没有主语。
• 对于同一个内容，上下文表述不一致。这在发明专利中是大忌。
• 说话具有不确定性。比如说你是一个具体的实验报告，但是他出现了大量“如果用的是什么什么，那就什么什么”。
• 出现过的符号和公式没有进行解释，一个符号在全文中有两种不同的表达。
• 参考文献不按照顺序，比如说[1]后面直接就是[3]。一句话有一堆参考文献，参考文献没有均匀的分布在全文。
• 使用形如"A-B-C"或"A+B+C"的表述方式，比如"质量-弹簧-阻尼"模型

解决以上问题

解决这些问题其实很简单，只要在每次要求修改前和ai说：不要在在中文和英文、数字之间加入空格，尽可能少的使用引号、分号、破折号，不要生硬地堆叠排比句，不要使用类似于“不是...而是..."这样的先否定再肯定的表述形式，不要使用类似“全链路闭环机制”这样的生僻词汇表达，说话需要有主语，对于同一名词全文表述需要统一、逻辑需要一致，用语需要有确定性（对于一个具体的实验来说，不能出现“如果用的是什么什么，那就什么什么”这样的表达）。每一个第一次出现的符号和公式都需要进行解释，并且文中一个符号不能表示两个不同的含义。参考文献必须按照出现顺序进行排序，不要出现[1]后面直接就是[3]的情况。一句话不能有多个参考文献，让参考文献尽量均匀的分布在全文。不要使用形如"A-B-C"或"A+B+C"的表述方式，比如"质量-弹簧-阻尼"模型。

当然如果你经常要写文档，觉得每次都打一遍很麻烦，也可以加入到agent.md里面（如果是网页端你就直接在gpt里面设置一下），这样他每次调用的时候都会先看一下。

多用latex写作

众所周知，ai编辑word的能力一言难尽，就算你装了office相关的skill，表现效果也很差。但是latex就不一样了，ai对latex的掌握炉火纯青，能够很好的表达公式。排版相对来说也会比word更加好看一些。因此，本人强烈推荐大家都用latex写作！（虽然图片和表格有的时候会错位，但是word也一样不是吗）latex可以用texstudio来编辑，网上经常推荐用overleaf，但是我觉得不是很好用，而且最近overleaf好像出了点问题。

关于推荐的格式

我个人非常推荐大家都使用首行缩进和1.5倍行距，当然如果这个比赛给你规定了格式那一定要按照规定要求的来。设置方式也很简单，右键，选择“段落”，就可以看到了。latex可以自动生成目录还挺好的，word的话需要给你需要设置标题的文字右键设置一下标题等级，再插入目录。