Agent-Native文档系统：为智能体应用生成完整文档的终极指南

【免费下载链接】agent-native A framework for building agent-native applications. 项目地址: https://gitcode.com/GitHub_Trending/ag/agent-native

Agent-Native是一个构建智能体原生应用的强大框架，其内置的文档系统能够帮助开发者轻松生成完整、专业的项目文档。本文将详细介绍如何利用Agent-Native文档系统为智能体应用创建全面的文档，从快速查询到高级定制，让你的项目文档既专业又易于维护。

为什么选择Agent-Native文档系统？

在开发智能体应用时，文档的重要性不言而喻。Agent-Native文档系统提供了以下核心优势：

• 版本匹配：文档与安装的框架版本完全匹配，避免了因版本差异导致的问题
• 快速查询：提供多种便捷的搜索方式，帮助开发者迅速找到所需信息
• 结构化内容：采用清晰的组织结构，涵盖从基础操作到高级功能的所有内容
• 集成工具：与框架其他组件紧密集成，提供一致的开发体验

图：Agent-Native文档系统界面展示，清晰的结构和强大的搜索功能让文档查阅变得轻松

快速上手：文档系统基础操作

访问文档

Agent-Native文档随@agent-native/core包一起安装，位于以下路径：

node_modules/@agent-native/core/docs

这些本地文档与你安装的框架版本完全匹配，是开发时的首选参考资料。

使用命令行工具查询

从生成的应用根目录，你可以使用以下命令快速搜索文档：

# 列出所有可用文档
pnpm action docs-search --list

# 按关键词搜索
pnpm action docs-search --query "actions"

# 按slug精确查找
pnpm action docs-search --slug actions

如果操作运行器不可用，还可以直接使用rg命令搜索markdown文件：

rg -n "actions|automations|a2a|sharing" node_modules/@agent-native/core/docs

核心功能：文档系统的强大特性

智能内容组织

Agent-Native文档系统采用直观的内容组织方式，将不同任务与对应的文档页面关联起来：

任务	推荐阅读
定义或调用应用操作	content/actions.md, content/client.md
添加SQL数据、模式或访问规则	content/database.md, content/security.md, content/sharing.md
保持UI和智能体同步	content/context-awareness.md, content/client.md
构建无头或聊天优先应用	content/pure-agent-apps.md, content/agent-surfaces.md, content/using-your-agent.md
添加自动化或计划任务	content/automations.md, content/recurring-jobs.md
组合应用或调用兄弟智能体	content/a2a-protocol.md, content/multi-app-workspace.md, content/workspace.md

图：Agent-Native文档系统的内容结构，清晰展示了不同功能区域的文档组织

应用特定文档

除了框架文档外，每个生成的应用还会有自己的AGENTS.md文件和.agents/skills/目录，用于存储应用特定的行为和技能文档。这些文档与框架文档相辅相成，共同构成完整的项目文档体系。

技能文档

Agent-Native还提供了技能文档系统，每个技能都有自己的SKILL.md文件，如skills/visual-recap/SKILL.md。这些文档详细描述了技能的功能、使用方法和注意事项。

高级应用：定制和扩展文档系统

文档定制

Agent-Native允许你根据项目需求定制文档。你可以在应用根目录下创建自己的AGENTS.md文件，定义应用特定的规则和最佳实践。当本地指令与框架文档冲突时，本地应用指令优先。

文档扩展

如果需要添加自定义文档，可以将其放在项目的docs/目录下，如docs/auth.md。这些文档会与框架文档一起构成完整的项目文档资源。

图：Agent-Native文档定制界面，展示了如何添加和组织应用特定的文档内容

最佳实践：充分利用文档系统

开发前查阅

在实现非平凡的Agent Native功能之前，务必阅读与@agent-native/core一起安装的版本匹配文档。这可以帮助你避免常见错误，遵循最佳实践。

常用文档slug

以下是一些常用的文档slug，可通过pnpm action docs-search --slug <slug>快速访问：

需求	Slugs
操作和类型化客户端调用	actions, client
SQL、认证、访问、共享	database, authentication, security, sharing
对智能体可见的UI状态	context-awareness
无头和聊天优先应用	pure-agent-apps, agent-surfaces, using-your-agent
自动化和计划任务	automations, recurring-jobs
跨应用和外部智能体	a2a-protocol, external-agents, mcp-protocol, mcp-apps
技能和指令	skills-guide, writing-agent-instructions

避免常见误区

• 不要依赖记忆来使用框架API，本地包文档是更可靠的参考
• 在阅读actions文档之前，不要添加自定义REST包装器
• 在阅读using-your-agent和agent-surfaces文档之前，不要添加内联LLM调用

总结：提升智能体应用开发效率

Agent-Native文档系统是开发智能体应用的重要工具，它提供了版本匹配的文档内容、快速查询功能和灵活的定制选项。通过充分利用这一系统，开发者可以显著提高开发效率，减少错误，并确保项目文档的完整性和一致性。

无论是新手还是有经验的开发者，都能从Agent-Native文档系统中获益。开始使用它，为你的智能体应用创建专业、全面的文档吧！

要开始使用Agent-Native框架，请克隆仓库：

git clone https://gitcode.com/GitHub_Trending/ag/agent-native

探索更多文档内容，如packages/core/docs/AGENTS.md和packages/core/docs/SKILL.md，深入了解Agent-Native框架的强大功能。

【免费下载链接】agent-native A framework for building agent-native applications. 项目地址: https://gitcode.com/GitHub_Trending/ag/agent-native