diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 269074e..f200331 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -18,13 +18,19 @@ export default defineConfig({ text: '智能体使用说明', items: [ { text: '入门简介', link: '/agent/usage/introduction' }, - { text: '快速开始', link: '/agent/usage/quick-start' } + { text: '快速开始', link: '/agent/usage/quick-start' }, + { text: '迭代计划', link: '/agent/usage/plan' } ] }, { text: '智能体开发指南', items: [ { text: '开发简介', link: '/agent/dev/introduction' }, + { text: '架构设计', link: '/agent/dev/structure' }, + { text: '模型基座', link: '/agent/dev/models' }, + { text: '提示词工程', link: '/agent/dev/prompt' }, + { text: '评估体系', link: '/agent/dev/access' }, + { text: '知识库工程', link: '/agent/dev/knowledge' }, ] }], '/web/': [{ @@ -49,6 +55,10 @@ export default defineConfig({ text: '插件端开发指南', items: [ { text: '开发简介', link: '/plugin/dev/introduction' }, + { text: '架构设计', link: '/plugin/dev/structure' }, + { text: 'ArcGIS Pro地理处理工具', link: '/plugin/dev/arcgis-tool' }, + { text: '知识库', link: '/plugin/dev/knowledge' }, + { text: 'Python解释器', link: '/plugin/dev/python-interpreter' }, ] }] }, diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..3623c56 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,9 @@ +{ + "pasteImage.basePath": "${projectRoot}/assets", + "pasteImage.defaultName": "x", + "pasteImage.encodePath": "none", + "pasteImage.namePrefix": "img", + "pasteImage.insertPattern": "![](${imageFilePath})", + "pasteImage.path": "${projectRoot}/assets", + "pasteImage.prefix": "img" +} \ No newline at end of file diff --git a/README.md b/README.md index 520d881..04cd5f7 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,14 @@ ### 参与协作 -可直接使用Visual Studio Code（推荐）或Intellij Idea、PyCharm等集成开发环境打开本项目，直接开始编辑相应的文档 \ No newline at end of file +可直接使用Visual Studio Code（推荐）或Intellij Idea、PyCharm等集成开发环境打开本项目，创建自己的分支后，直接开始编辑相应的文档。 + +如果需要添加新的文章，在`/.vitepress/config.mts`中的sidebar添加相应的item，原则上不允许添加新的侧边栏组，nav中也不允许添加其它的子项目，文档中涉及的图片全部放到assets文件夹中，严禁在Markdown文档所在文件夹放图片。 + +### 语法参考 + +由于本项目基于Vitepress搭建，所以也支持Vitepress中对于Markdown语法的扩展，可以排版出美观的项目文档，具体参考[Vitepress官方文档](https://vitepress.dev/zh/reference/default-theme-config) + +## 文档预览 + +对于普通Markdown语法部分（占据文档库的大部分内容）可以直接使用Visual Studio Code自带的Markdown预览器预览效果，对于Vitepress拓展部分，可以通过`npm run docs:dev`命令开启实时预览，开启后，每次文档内容有更新就会自动刷新；也可以通过`npm run docs:build`生成相应的html文件。 \ No newline at end of file diff --git a/agent/dev/access.md b/agent/dev/access.md new file mode 100644 index 0000000..a221555 --- /dev/null +++ b/agent/dev/access.md @@ -0,0 +1,9 @@ +# 能力与效果评估 + +## 评估体系 + +介绍评估体系各个标准，含示例和介绍文字等 + +## 评估结果 + +介绍当前智能体的评估结果、与竞品对比、与人工操作对比、不同迭代版本的智能体对比等 \ No newline at end of file diff --git a/agent/dev/introduction.md b/agent/dev/introduction.md index 974d0a1..2be6883 100644 --- a/agent/dev/introduction.md +++ b/agent/dev/introduction.md @@ -1 +1,9 @@ -# 开发简介 \ No newline at end of file +# 开发简介 + +## 主要功能 + +介绍我们这个智能体主要用于做什么的 + +## 创新特色 + +列举并介绍智能体部分投稿比赛、吸引评委和观众的创新点，突出亮眼的地方（包括功能上、设计思路上等） \ No newline at end of file diff --git a/agent/dev/knowledge.md b/agent/dev/knowledge.md new file mode 100644 index 0000000..e24498f --- /dev/null +++ b/agent/dev/knowledge.md @@ -0,0 +1,13 @@ +# 知识库 + +## 简介 + +简要介绍有哪些知识库、大致是些什么内容 + +## 知识库构建 + +详细记录知识爬取、整理、翻译等等我们前期构建知识库时所做的工作 + +## 实现方法 + +介绍通过阿里云百炼平台实现知识库管理、检索、命中测试等的方法 \ No newline at end of file diff --git a/agent/dev/models.md b/agent/dev/models.md new file mode 100644 index 0000000..caefa35 --- /dev/null +++ b/agent/dev/models.md @@ -0,0 +1,9 @@ +# 模型基座 + +## 支持列表 + +介绍当前智能体支持的主要模型基座，列表展示（出品方、参数量、API平台、模型名称） + +## 模型表现 + +对比介绍不同模型、不同参数量在实际任务中的表现，并给出建议：哪些模型适合完成什么任务 \ No newline at end of file diff --git a/agent/dev/prompt.md b/agent/dev/prompt.md new file mode 100644 index 0000000..10283fe --- /dev/null +++ b/agent/dev/prompt.md @@ -0,0 +1,13 @@ +# 提示词 + +## 简介 + +简单介绍通过提示词实现什么样的效果，提示词主要包括哪些内容等 + +## 设计 + +介绍当前提示词是怎么设计的（详细介绍包括哪些部分的内容，预期、实测产生什么样的效果） + +## 调试方法 + +总结一些提示词工程的技巧，例如提供示例、提出禁止性要求之类的 \ No newline at end of file diff --git a/agent/dev/structure.md b/agent/dev/structure.md new file mode 100644 index 0000000..23d759e --- /dev/null +++ b/agent/dev/structure.md @@ -0,0 +1,9 @@ +# 架构设计 + +## 架构简介 + +绘制智能体架构设计图，介绍智能体的组成及各模块的主要功能，模块之间的关系等（注意与插件的架构图有所区分，本部分主要是介绍智能体本身的，可忽略程序开发相关内容） + +## 工作流程 + +介绍智能体收到需求后的工作流程 \ No newline at end of file diff --git a/agent/usage/introduction.md b/agent/usage/introduction.md index 17fe94c..d10e0af 100644 --- a/agent/usage/introduction.md +++ b/agent/usage/introduction.md @@ -1,2 +1,8 @@ # 智能体简介 +## 简介 + +大致介绍我们的智能体是干什么用的，本部分主要面向用户，所以偏使用的角度进行介绍，与开发部分的简介不同 + +## 展望 + diff --git a/agent/usage/plan.md b/agent/usage/plan.md new file mode 100644 index 0000000..6846f87 --- /dev/null +++ b/agent/usage/plan.md @@ -0,0 +1,3 @@ +# 更新计划 + +介绍一下智能体后续更新的方向和时间节点安排，展望未来实现的能力 \ No newline at end of file diff --git a/agent/usage/quick-start.md b/agent/usage/quick-start.md index 55b6f79..b707562 100644 --- a/agent/usage/quick-start.md +++ b/agent/usage/quick-start.md @@ -1 +1,5 @@ -# 快速开始 \ No newline at end of file +# 快速开始 + +## 接入智能体 + +介绍如果程序需要接入智能体，需要实现些什么（例如：模型基座请求、MCP服务等） \ No newline at end of file diff --git a/assets/PixPin_2025-07-13_20-42-45.png b/assets/PixPin_2025-07-13_20-42-45.png new file mode 100644 index 0000000..d332b4c Binary files /dev/null and b/assets/PixPin_2025-07-13_20-42-45.png differ diff --git a/plugin/dev/arcgis-tool.md b/plugin/dev/arcgis-tool.md new file mode 100644 index 0000000..853ae18 --- /dev/null +++ b/plugin/dev/arcgis-tool.md @@ -0,0 +1,15 @@ +# ArcGIS Pro地理处理工具 + +## 简介 + +## 实现思路 + +## 示例 + +## 资源拓展 + +### 列出数据库中的数据 + +### 数据属性 + +### 数据内容 \ No newline at end of file diff --git a/plugin/dev/introduction.md b/plugin/dev/introduction.md index 974d0a1..97ff7e3 100644 --- a/plugin/dev/introduction.md +++ b/plugin/dev/introduction.md @@ -1 +1,9 @@ -# 开发简介 \ No newline at end of file +# 开发简介 + +## 技术栈 + +介绍插件开发所用到的技术栈，以及其提供的能力 + +## 组成部分 + +介绍插件的主要组成部分及其作用 \ No newline at end of file diff --git a/plugin/dev/knowledge.md b/plugin/dev/knowledge.md new file mode 100644 index 0000000..da128da --- /dev/null +++ b/plugin/dev/knowledge.md @@ -0,0 +1,5 @@ +# 知识库 + +## 功能 + +## 实现流程 \ No newline at end of file diff --git a/plugin/dev/python-interpreter.md b/plugin/dev/python-interpreter.md new file mode 100644 index 0000000..0940049 --- /dev/null +++ b/plugin/dev/python-interpreter.md @@ -0,0 +1,7 @@ +# Python解释器 + +## 简介 + +实现什么功能 + +## 实现思路 \ No newline at end of file diff --git a/plugin/dev/structure.md b/plugin/dev/structure.md new file mode 100644 index 0000000..2955f61 --- /dev/null +++ b/plugin/dev/structure.md @@ -0,0 +1,9 @@ +# 系统架构 + +## 架构设计 + +介绍插件端的架构图、架构设计 + +## 工作流程 + +介绍插件端的整个工作流程 \ No newline at end of file diff --git a/plugin/usage/introduction.md b/plugin/usage/introduction.md index 47374d2..022267b 100644 --- a/plugin/usage/introduction.md +++ b/plugin/usage/introduction.md @@ -1 +1,9 @@ -# 入门简介 \ No newline at end of file +# 入门简介 + +## 简介 + +介绍插件能干什么、用在哪 + +## 安装使用 + +介绍插件如何安装、如何使用，界面交互、按钮功能等 \ No newline at end of file