计算机协会文档

主题

用 AI 帮忙写文档 ​

本文说明 AI 适合做哪些文档工作，不适合做哪些，以及怎样核实 AI 的输出。

概览 ​

AI 可以把口头记录整理成条目，把不通顺的句子改通顺，把英文资料翻译成中文。它做这些事又快又好。

AI 不能为内容负责。它会用确定的语气给出编造的事实、不存在的网址和错误的命令。文档发布后，读者会照着做。出错的后果由协会承担，不由 AI 承担。

本站的规则是：可以用 AI 起草，但每一条事实都必须由你核实后才能提交。

可以交给它做的事 ​

  • 整理。把会议的零散记录、聊天里的结论，整理成分节的条目。
  • 润色。你已经写好意思，让它把句子改通顺、去掉重复。
  • 翻译。把英文官方文档的一段转成中文，作为你理解的辅助。
  • 对照检查。把你写的和本站已有的页面一起给它，让它指出语域和格式上的不一致。
  • 找出你没想到的情况。例如问它“这段命令在 Windows 上会怎样”。你要自己验证它的答案，但它能提醒你考虑这种情况。

不要交给它做的事 ​

  • 不要让它替你确定事实。 版本号、端口号、命令参数、日期、人名，都要你自己查。
  • 不要让它生成参考链接。 它编出来的网址常常长得很像真的。本站每个外链都要点开确认过。
  • 不要让它写归档内容。 归档记录真实发生过的事。缺少的内容要标出来。任何补全都是伪造史料。
  • 不要整篇照抄它的输出。 AI 写的中文容易识别：大量使用“因此”“总之”“不难看出”和破折号，常说“非常重要”“极大提升”。本站正文中不使用这些词。

怎么核实它给的东西 ​

  • 命令：在你的电脑上运行一次。如果不能运行（例如你没有 Windows），在官方文档中确认参数，或者在文中注明这条命令没有经过测试。

  • 事实和数字：找到一手出处。规范查 RFC 或标准组织的文件，工具查官方手册，本仓库的情况查仓库中的文件。出处和锚点的写法见现有教程中的“延伸阅读”。

  • 链接：打开每一个链接。要批量检查站内链接，构建后运行：

    bash
    pnpm run ci:verify

    这条命令报告站内的失效链接和失效锚点。站外链接要你自己打开检查。

  • 渲染结果：AI 写的 Markdown 在本站可能不能正确显示。用构建产物判断，见 VitePress。

让它写出本站的样子 ​

如果只让 AI“写一篇技术文档”，结果不会符合本站的写法。给它下面这些约束：

  1. 让它先读一两篇本站已有的同类页面，并要求它“照这个语域写”。
  2. 要求引号用 “”，不要用 「」。
  3. 要求不用破折号连接句子，不写“因此”“总之”等过渡词。
  4. 要求每个结论附出处链接，链接到具体条款，不链接到文档首页。
  5. 要求命令给出 macOS、Linux 和 Windows 三种写法。

完成后，自己通读全文。只有每一句都通顺、准确，才可以提交。

一段可以直接用的提示词 ​

text
我要给 NBTCA 文档站写一页文档，主题是（……）。

先读这两页作为语域参考：
https://docs.nbtca.space/tutorial/terminal-shell-and-path
https://docs.nbtca.space/tutorial/manual/writing-documents

要求：
1. 中文正文，代码和命令用英文。引号用中文双引号，不要用直角引号。
2. 不要用破折号堆句子，不要写“因此”“总之”“不难看出”这类过渡词。
3. 每个结论附出处链接，链到具体的条款或章节，不要只链首页。
4. 命令给出 macOS、Linux、Windows 三种写法。
5. 你不确定的地方直接写“待核实”，不要猜，不要编链接。

写完列一张清单，说明哪些内容你没有把握、需要我去核实。

最后一句要求模型列出没有把握的内容，使这些内容不会混在正文中。

归档的红线 ​

注意

不要把 AI 生成的内容放入 archived/。archived/ 中的内容是协会的史料。让模型补全一段“看起来合理”的会议内容，就是伪造记录。

AI 可以把已有的记录整理成条目，或者改通顺。AI 不能产生原来没有的事实。

原件缺失的地方，用 〔待核实：……〕 标注。它显示为一个带标签的待办标记，写法见 VitePress。

相关页面 ​