随着越来越多的 AI 智能体开始阅读技术文档围绕信息发布与结构组织的要求也在发生变化。Docsy 是由 Google 创建的文档项目已被多个主要的云原生项目采用目前正加入 Linux 基金会同时新增了专门针对机器读者的功能。Google 高级开发者关系工程师、Docsy 指导委员会成员 Erin McKean于周三在布拉格举行的 Linux 基金会欧洲开源峰会主题演讲中宣布了这一消息。Docsy 于 2019 年由 Google 首次推出是为 Hugo 静态站点生成器设计的开源主题专门用于技术文档。它可以用于一般性的文档编写包括专有项目不过在开源领域的应用尤为广泛。截至 2024 年底约有 2200 个项目在使用 Docsy采用者包括云原生计算基金会CNCF旗下的多个项目如 Kubernetes、OpenTelemetry、gRPC 和 Jaeger。开源项目标题McKean 表示Docsy 在 Linux 基金会社区中已有的使用基础正是推动此次转移的部分原因。在主题演讲结束后的交谈中她指出将 Docsy 纳入基金会能让它更贴近许多已经在使用它的项目。“开源项目在贴近用户的时候效果最好”McKean 对 The New Stack 表示。AI 同样需要优质文档在主题演讲中McKean 重点谈到了 AI 作为技术文档新读者的崛起。她承认一些技术文档撰写者对此略有酸味因为是 AI 的出现才为文档工作带来了更多资源。但她认为关键在于信息最终能够抵达并帮助到开发者。“当我们在编写技术文档时信息如何变得对人类有用其实并不重要只要它确实有用”McKean 说。“如果有人告诉我有证据表明歌剧是触达项目用户的最佳方式我也会去写歌剧。”Docsy 已经开始为 AI 工具调整其输出内容。自 5 月发布的 0.15.0 版本起它可以在生成常规 HTML 的同时生成每个页面的 Markdown 副本以及一个 llms.txt 文件为 AI 工具提供站点内容的索引。这两项功能均为可选启用目前仍处于实验阶段。更广泛的设想是为 AI 系统提供一条更直接的路径使其能够获取项目希望它们使用的信息。“你可以将大语言模型和智能体引导至说明项目使用方法的文本上”McKean 说。Docsy 持续围绕这一基本理念增加新功能。7 月发布的 0.16.0 版本中包含了一份升级指南其编写方式也便于 AI 助手遵循指南中内置了条件、步骤和检查环节。而在 8 月发布的 0.17.0 版本中Docsy 在帮助智能体消化文档内容方面更进一步。启用了 llms.txt 的站点现在会在每个页面顶部自动包含一条隐藏指令引导访问的智能体找到站点的 llms.txt 索引。该功能同样处于实验阶段。为智能体评分文档路线图上的下一步是推出AF即 agent-friendly智能体友好文档评分旨在为维护者提供一种方式评估 AI 工具查找、导览和消化其文档的难易程度。McKean 表示这将为项目提供一个可以努力达到的基准。“你不必再去猜测”她说。“你可以直接测量你的文档对智能体的友好程度。”更优质的文档还带来了一个更为传统的好处减少落到维护者身上的常规问题。McKean 表示好的文档能够在需要人工介入之前就先解答这些问题。“当你拥有良好的文档时它能减少那些可以通过文档轻松解答的问题数量从而减轻维护者的负担”她说。
随着越来越多的 AI 智能体开始阅读技术文档围绕信息发布与结构组织的要求也在发生变化。Docsy 是由 Google 创建的文档项目已被多个主要的云原生项目采用目前正加入 Linux 基金会同时新增了专门针对机器读者的功能。Google 高级开发者关系工程师、Docsy 指导委员会成员 Erin McKean于周三在布拉格举行的 Linux 基金会欧洲开源峰会主题演讲中宣布了这一消息。Docsy 于 2019 年由 Google 首次推出是为 Hugo 静态站点生成器设计的开源主题专门用于技术文档。它可以用于一般性的文档编写包括专有项目不过在开源领域的应用尤为广泛。截至 2024 年底约有 2200 个项目在使用 Docsy采用者包括云原生计算基金会CNCF旗下的多个项目如 Kubernetes、OpenTelemetry、gRPC 和 Jaeger。开源项目标题McKean 表示Docsy 在 Linux 基金会社区中已有的使用基础正是推动此次转移的部分原因。在主题演讲结束后的交谈中她指出将 Docsy 纳入基金会能让它更贴近许多已经在使用它的项目。“开源项目在贴近用户的时候效果最好”McKean 对 The New Stack 表示。AI 同样需要优质文档在主题演讲中McKean 重点谈到了 AI 作为技术文档新读者的崛起。她承认一些技术文档撰写者对此略有酸味因为是 AI 的出现才为文档工作带来了更多资源。但她认为关键在于信息最终能够抵达并帮助到开发者。“当我们在编写技术文档时信息如何变得对人类有用其实并不重要只要它确实有用”McKean 说。“如果有人告诉我有证据表明歌剧是触达项目用户的最佳方式我也会去写歌剧。”Docsy 已经开始为 AI 工具调整其输出内容。自 5 月发布的 0.15.0 版本起它可以在生成常规 HTML 的同时生成每个页面的 Markdown 副本以及一个 llms.txt 文件为 AI 工具提供站点内容的索引。这两项功能均为可选启用目前仍处于实验阶段。更广泛的设想是为 AI 系统提供一条更直接的路径使其能够获取项目希望它们使用的信息。“你可以将大语言模型和智能体引导至说明项目使用方法的文本上”McKean 说。Docsy 持续围绕这一基本理念增加新功能。7 月发布的 0.16.0 版本中包含了一份升级指南其编写方式也便于 AI 助手遵循指南中内置了条件、步骤和检查环节。而在 8 月发布的 0.17.0 版本中Docsy 在帮助智能体消化文档内容方面更进一步。启用了 llms.txt 的站点现在会在每个页面顶部自动包含一条隐藏指令引导访问的智能体找到站点的 llms.txt 索引。该功能同样处于实验阶段。为智能体评分文档路线图上的下一步是推出AF即 agent-friendly智能体友好文档评分旨在为维护者提供一种方式评估 AI 工具查找、导览和消化其文档的难易程度。McKean 表示这将为项目提供一个可以努力达到的基准。“你不必再去猜测”她说。“你可以直接测量你的文档对智能体的友好程度。”更优质的文档还带来了一个更为传统的好处减少落到维护者身上的常规问题。McKean 表示好的文档能够在需要人工介入之前就先解答这些问题。“当你拥有良好的文档时它能减少那些可以通过文档轻松解答的问题数量从而减轻维护者的负担”她说。
平方复杂度无法被常规优化消除｜TaoToken 统一 Key 通道实测)
