AgileBuilder logoAgileBuilder
返回文档

文档系统

了解 AgileBuilder 的文档系统

概述

AgileBuilder 的文档系统允许你录入团队规范文档，并将其映射为 MCP 中的 resource，供 AI 工具实时查询。这意味着 AI 可以基于你的团队规范来生成代码，而不是凭空创作。

文档系统架构

为什么需要文档系统

在 AI 开发时代，团队通常面临以下问题：

  • AI 生成的代码不符合团队规范
  • 每次都要在提示词中重复团队约定
  • AI 不了解项目的特定要求

通过文档系统，你可以：

  • 将团队规范文档化
  • 让 AI 实时查询团队规范
  • 确保 AI 生成的代码符合团队标准

文档录入

在控制台录入

  1. 登录 AgileBuilder 控制台
  2. 进入「文档库」页面
  3. 点击「添加文档」

添加文档

文档格式

支持以下格式：

格式说明
Markdown (.md)最常用的格式
Text (.txt)纯文本
JSON (.json)结构化数据
YAML (.yaml)配置文件

文档结构

建议按以下结构组织文档：

docs/
├── README.md              # 文档库索引
├── coding-standards.md    # 代码规范
├── api-spec.md           # API 规范
├── naming-conventions.md  # 命名约定
└── best-practices.md      # 最佳实践

MCP Resource 映射

录入的文档会自动映射为 MCP resource，供 AI 查询：

resource://agile-builder/docs/coding-standards
resource://agile-builder/docs/api-spec
resource://agile-builder/docs/naming-conventions

在 AI 中使用

配置 MCP 后，AI 可以这样查询：

"查看我们的代码规范"
"根据 API 规范生成 CRUD 代码"
"检查这个命名是否符合约定"

文档标签

为文档添加标签，便于管理和检索：

tags:
  - 代码规范
  - 前端
  - TypeScript

常用标签建议

标签用途
代码规范代码风格、lint 规则
API 规范接口设计、数据格式
命名约定变量、函数、文件的命名规则
最佳实践经验总结、最优方案
架构系统设计、模块划分

文档版本

文档支持版本管理：

  1. 版本历史：每次修改都会记录版本
  2. 版本回滚：可以回滚到任意历史版本
  3. 版本对比：可以对比不同版本的差异

团队共享

文档可见性

可见性说明
私有仅自己可见
团队团队成员可见
公开所有用户可见

文档审核

团队可以设置文档审核流程：

  1. 提交文档修改
  2. 团队成员审核
  3. 合并到正式版本

与模板结合

文档系统与模板系统结合使用，效果最佳：

模板定义结构 ──────→ 生成项目骨架
    ↓
文档定义规范 ──────→ AI 查询执行
    ↓
生成符合规范的项目

下一步