面向技术团队的集中式文档平台

大多数工程团队实际上并不需要一个新的集中式文档平台。因为他们通常已经有了一个（如 Confluence、Notion、GitHub wiki 或内部开发者门户）。他们真正需要的是一种能够用最新技术文档填充该平台的方法。Trupeer AI 的技术文档工具只需记录一次工作流，即可生成精美的视频演示和书面技术指南，并可随时嵌入团队已作为中央文档层使用的任何平台中。大多数技术文档的瓶颈在于制作，而非存储。

• 只需记录一次技术工作流。即可在同一次任务中获得精美的视频和书面技术指南。

• 将输出内容嵌入任何现有的集中式文档平台：Confluence、Notion、GitHub wiki 或内部开发者门户。

• 通过重新录制发生变化的步骤来进行更新。技术文档的其余部分则保持不变。

• 为全球工程团队将技术文档翻译成 65 多种语言。

• 通过品牌化的“分享页面”链接进行分享，团队可以将其发布在 Slack 中、嵌入任何 wiki 中，或者提交给支持团队。

Trupeer AI 为技术文档生成什么内容

工程师可以录制部署、调试会话、事件响应流程或任何其他技术工作流的屏幕演示。Trupeer AI 会负责后期制作。语气词（如“呃”、“让我找一下正确的标签页”等尴尬时刻）会被自动移除。光标抖动和缩放过渡会变得平滑。草稿视频和草稿书面技术指南会在同一次任务中提供，这样团队就无需为同一流程维护两个独立的“单一真理来源”。

输出的视频格式为 MP4，可直接嵌入任何技术文档软件中。输出的文档格式为 PDF 或 Word，可直接用于工程 wiki 或提交给评审人员。品牌套件会自动应用：企业 logo、颜色、字体、片头和片尾幻灯片都会与工程文档库的其余部分保持一致。自定义词汇表能够处理 AI 原本不知道如何拼写或发音的内部产品名称、工具名称和 API 名称，这对于技术性内容而言比任何其他文档类型都更为重要。AI 屏幕录制层可处理光标高亮、区域聚焦以及对 UI 交互的自动缩放，而这正是大多数技术写作工具要么忽略、要么做得不好的地方。

技术文档工具工作原理的三个步骤

完整的流程只需一次录制，就能生成可供随时交付的技术文档。无需准备脚本，无需单独的技术写作环节，也无需在未来的两个季度中去慢慢清理积压的文档。

步骤 1：录制技术工作流

在浏览器中点击录制，捕获实际执行的工作流，或者上传现有的屏幕录像。AI 会针对录制的内容进行处理。录制一个 12 分钟的部署过程比单凭记忆编写一份 4 页的运行手册要快得多，而且生成的内容也更加准确，因为这些文档反映的是工程师实际执行的操作，而不是他们凭记忆想起来的操作。

步骤 2：Trupeer AI 生成视频和书面技术指南

语气词会被自动移除。在有助于观众理解屏幕操作的地方，会自动添加缩放和光标效果。草稿视频和草稿技术指南将同时出现在编辑器中。由于应用了自定义词汇表，内部工具名称、API 端点和产品名称在两种输出格式中都会得到正确的拼写和发音。

步骤 3：应用品牌、翻译并交付至现有的集中式平台

应用品牌套件，使企业 logo、颜色以及片头/片尾幻灯片与工程文档库的其余部分相匹配。翻译成全球工程团队所使用的语言（西班牙语、普通话、印地语、葡萄牙语或 65 多种选项中的任何一种）。然后通过一个分享页面链接进行交付，团队可以将其嵌入 Confluence、Notion、GitHub wiki、内部开发者门户或团队已在使用的任何其他集中式文档平台中。

哪些人实际上会使用 Trupeer AI 来制作技术文档

使用此工具的人通常是技术主管、工程经理或 DevOps 主管，其所在公司的“文档化”至少已连续两个季度被列为 OKR。一致的情况是，工程团队知道哪些内容需要文档化。但他们缺少的是那些愿意花一周时间去编写原本只需 30 分钟即可录制完成的内容的人。Trupeer AI 缩小了“知道该将什么文档化”与“实际生成该文档”之间的差距。

同样的工作流会出现在不同的角色中。SRE 和 DevOps 团队将其用于事件响应运行手册、部署流程和基础架构演示。平台工程团队将其用于内部工具文档，以解释团队自主研发的系统实际上是如何运作的。工程经理用它来为新员工交付入职培训文档，涵盖环境搭建、代码库规范以及针对特定团队的工具使用。开发者体验团队用它为公司其他部门所依赖的内部 API 和共享库创建技术文档。一些团队将其视为招聘技术文档撰写人员的替代方案；而另一些团队则将其与技术文档撰写人员配合使用，以使其产出成倍增长。

Trupeer AI 处理的技术文档使用场景

技术文档通常涵盖四类内容：某物如何工作、如何做某事、当某物损坏时发生了什么，以及系统之间的边界在哪里。Trupeer AI 通过相同的“录制到文档”流程处理所有这四类内容。部署演示、环境搭建指南、事件事后分析和架构概述都可以从屏幕录像开始，并以精美的视频加书面技术指南结束。以前需要技术写作模板、下载的技术文档模板、通过 Google 检索到的标准技术写作模板或通用的 word 格式技术文档模板才能完成的格式，现在完全可以根据工程师的需要来生成，并由 AI 自动完成结构化。对于那些之前仅为了获得一个可用模板而评估独立技术写作软件的团队，一旦引入 Trupeer，通常就会放弃那一层。

对于软件技术文档，回报最快的使用场景是内部工具的演示。每个工程团队都至少拥有少数几个团队外部人员不知道如何使用的自研工具。在同一个任务中记录这些工具的实际使用情况并生成视频和书面文档，意味着下一个需要使用该工具的工程师无需在 Slack 上询问开发该工具的团队。这一模式同样适用于技术设计文档：无需在事后撰写设计方案，只需录制设计评审会议，并让 Trupeer AI 从中生成结构化的技术文档。事后分析和根因分析的技术报告撰写也是如此：录制分析会议、生成文档并进行交付。

当团队意识到他们可以通过重新录制来更新现有的技术文档，而不是将每次更新都当成一次彻底的重写时，用于技术写作的 AI 就体现出了它的价值。同样逻辑也适用于更为广泛的技术内容写作。当编写文档的成本降到比每个季度在 Slack 中解释同一件事情四次还要低时，工程团队就不会再逃避写文档了。这种转变正是技术团队的集中式文档平台本应实现的结构性变化，也是大多数平台留给团队自行解决的痛点。Trupeer AI 是大多数团队用来作为软件技术文档范例的首选，因为它的输出足够具体，可以作为优秀技术写作和文档实际样貌的参考。

Trupeer AI 在 Confluence、Notion、GitHub wiki 等集中式工具中的定位

Trupeer AI 并不取代集中式存储层。Wiki 依然是 wiki。Confluence 依然是所有团队文档存放的地方。Notion 依然是工程团队的内部知识库。GitHub wiki 依然是临近代码库的文档归属地。内部开发者门户也依然是权威的单一真理来源。Trupeer AI 位于工作流程中更靠前的一步，即实际生产文档内容的地方，并将输出结果以“分享页面”链接的形式交付，该链接可以嵌入到任何现有的集中式存储层中，而无需改变团队现有的配置。

大多数工程团队已经在他们首选的集中式工具上进行了投资。他们不想迁移，他们只希望现有的工具中确实能包含最新的文档。Trupeer AI 的“分享页面”链接正是缩小这一差距的机制：当底层录制更新时，视频和文档都会同步更新，这意味着任何在团队 wiki 中拥有该嵌入链接的人都会自动看到最新版本。Wiki 依然作为存储和检索层。而 Trupeer AI 则负责上游的生产和持续的主持维护，而这正是大多数集中化平台留给团队自行解决的问题。

更新：重新录制发生变化的步骤，保持技术文档的其余部分完好无损

技术文档比任何其他类型的文档失效得都快，因为底层系统每周都在发生变化。当团队迁移到新的 CI/CD 平台时，部署流程就会发生变化。当数据库开发商改变时，事件运行手册就会发生变化。当团队采用新的 IDE 或迁移到不同的代码评审工具时，入职指南就会发生变动。大多数文档工具都迫使团队每次都要从头重写受影响的部分。而 Trupeer AI 通过仅重新录制发生变化的步骤来处理更新。

重新录制比重写更快捷。最初录制工作流的工程师只需录制发生变化的步骤的新版本即可。AI 仅对该片段进行重新处理。视频和书面技术指南都会在原处进行更新。团队在上个季度分发的任何“分享页面”链接现在都会指向当前版本，且更新后的步骤已融入整个文档的其余部分中。任何将原始链接加入书签或将其嵌入团队 wiki 的人员都将获得新内容，无需任何手动的追溯。这种更新模式正是使技术文档在底层系统不断变化的数月和数年里能够真正保持可用性的关键。将该生成器与 Trupeer AI SOP 构建器结合使用，还可以涵盖记录的技术工作流底层的标准作业程序。