开发文档

Name: 开发文档
Author: cyberagiinc

作者：cyberagiinc1968 星标更新：2025-11-20

安装使用来源：spider==github.com

项目介绍

DevDocs by CyberAGI 🚀

<div align="center"> <img src="assets/image.png" alt="DevDocs界面" width="800"> <p align="center"> <strong>将数周的文档研究时间缩短到数小时的高效开发</strong> </p> <p align="center"> <a href="#-perfect-for">适合谁</a> • <a href="#-features">特性</a> • <a href="#-why-devdocs">为什么选择DevDocs</a> • <a href="#-getting-started">快速开始</a> • <a href="#-scripts-and-their-purpose">脚本及其用途</a> • <a href="#-pricing-comparison">与FireCrawl对比</a> • <a href="#-join-our-community">Discord社区</a> • <a href="#-devdocs-roadmap">DevDocs路线图</a> </p> </div>

🚀 技术合作伙伴

🎯 适合谁

🏢 企业软件开发者

跳过数周阅读文档和技术债务处理。通过让DevDocs处理文档理解的繁重工作，实现任何技术的快速实施。

🕸️ 网页抓取者

提取网站的全部内容，智能发现子URL至第5级。适用于内部和外部网站文档的智能爬取。

👥 开发团队

利用内置的MCP服务器和Claude集成进行智能数据查询，将团队的知识库转化为可操作资源。

🚀 独立黑客

DevDocs + VSCode(cline) + 你的想法 = 快速构建产品，使用任何技术。在构建下一个大项目时，不再陷入文档地狱。

✨ 特性

🧠 智能爬取

智能深度控制：选择爬取深度从1到5级
自动链接发现：查找并分类所有相关内容
选择性爬取：精确选择要提取的内容
子URL检测：自动发现并映射网站结构

⚡ 性能与速度

并行处理：同时爬取多个页面
智能缓存：避免重复内容浪费时间
懒加载支持：轻松处理现代Web应用
速率限制：尊重目标服务器，防止过载

🎯 内容处理

干净提取：获取无冗余的内容
多种格式：导出为MD或JSON用于LLM微调
结构化输出：逻辑组织内容
MCP服务器集成：准备好进行AI处理

🛡️ 企业特性

错误恢复：失败后自动重试
全面日志：跟踪每个操作
API访问：与您的工具集成
团队管理：多席位和角色

🤔 为什么选择DevDocs？

遇到的问题

文档无处不在，而LLMs的知识是过时的。即使是资深工程师，阅读、理解和实现这些文档也需要数周的研究和开发时间。我们将其缩短到了数小时。

我们的解决方案

DevDocs将文档带到您身边。指向任何技术文档URL，它会：

发现该技术的所有相关页面
提取有意义的内容，去除冗余
在MCP服务器中逻辑组织信息，以便您的LLM查询
以干净、可搜索的格式呈现，可用于MD或JSON格式的LLM微调

🔥 我们希望世界上任何人都能够快速地使用最前沿的LLM技术来构建令人惊叹的产品。

💰 价格比较

功能	DevDocs	Firecrawl
免费层级	无限页面	无
起始价格	永久免费	每月$16
企业计划	定制	每月$333
爬取速度	每分钟1000页	每分钟20页
深度级别	最高5级	有限
团队席位	无限	1-5席
导出格式	MD, JSON, LLM准备好的MCP服务器	有限格式
API访问	即将推出	有限
模型上下文协议集成	✅	❌
支持	通过Discord优先提供	标准支持
自托管（免费使用）	✅	❌

🚀 快速开始

DevDocs旨在通过Docker易于使用，对新用户来说设置简单。

前提条件

在系统上安装Docker
使用Git克隆仓库

使用Docker快速开始（推荐）

对于Mac/Linux用户：

# 克隆仓库
git clone https://github.com/cyberagiinc/DevDocs.git

# 进入项目目录
cd DevDocs

# 配置环境变量
# 复制模板文件到.env
cp .env.template .env

# 确保.env中的NEXT_PUBLIC_BACKEND_URL设置正确（例如，http://localhost:24125）
# 这允许前端（运行在浏览器中）与后端服务通信。

# 使用Docker启动所有服务
./docker-start.sh

对于Windows用户：实验性（尚未测试）

# 克隆仓库
git clone https://github.com/cyberagiinc/DevDocs.git

# 进入项目目录

cd DevDocs

# 配置环境变量
# 复制模板文件到.env

copy .env.template .env

# 确保.env中的NEXT_PUBLIC_BACKEND_URL设置正确（例如，http://localhost:24125）

# 这允许前端（运行在浏览器中）与后端服务通信。

# 前提条件：安装WSL 2和Docker Desktop
# Docker Desktop for Windows需要WSL 2。请确保您已安装并运行了WSL 2。
# 1. 安装WSL 2：遵循官方Microsoft指南：https://learn.microsoft.com/en-us/windows/wsl/install
# 2. 安装Docker Desktop for Windows：从官方Docker网站下载并安装。Docker Desktop包括Docker Compose。



# 使用Docker启动所有服务
docker-start.bat

<details> <summary>注意事项：Windows用户</summary>

如果遇到权限问题，可能需要以管理员身份运行脚本或手动设置日志、存储和crawl_results目录的权限。脚本使用icacls命令设置权限，这可能需要某些Windows系统上的提升权限。

手动设置Windows权限：

如果需要手动设置权限，可以使用Windows GUI或命令行：

使用Windows资源管理器：

右键点击每个目录（日志、存储、crawl_results）

选择“属性”

转到“安全”标签

点击“编辑”更改权限

点击“添加”添加用户/组

输入“Everyone”并点击“检查名称”

点击“确定”

在列表中选择“Everyone”

在“允许”下勾选“完全控制”

点击“应用”和“确定”

使用命令提示符（以管理员身份）：
icacls 日志 /grant Everyone:F /T
icacls 存储 /grant Everyone:F /T
icacls crawl_results /grant Everyone:F /T

</details> <details> <summary>关于Windows上的docker-compose.yml注意事项</summary>

如果遇到docker-compose.yml文件的问题（如“顶级对象必须是一个映射”错误），docker-start.bat脚本会自动修复此问题，确保文件具有正确的格式和编码。每次运行脚本时都会应用此修复，因此无需手动修改文件。

</details>

此单个命令将：

创建所有必要的目录
设置适当的权限
构建并启动所有Docker容器
监控服务以确保其正常运行

访问DevDocs

一旦服务运行：

前端UI：http://localhost:3001
后端API：http://localhost:24125
Crawl4AI服务：http://localhost:11235

日志和监控

使用Docker时，可以通过以下方式访问日志：

容器日志（推荐用于调试）：

# 查看特定容器的日志
docker logs devdocs-frontend
docker logs devdocs-backend
docker logs devdocs-mcp
docker logs devdocs-crawl4ai

# 实时跟随日志
docker logs -f devdocs-backend

要停止所有服务，请按Ctrl+C在运行docker-start的终端中。

📜 脚本及其用途

DevDocs包含各种实用脚本，帮助开发、测试和维护。这里有一个快速参考：

启动脚本

start.sh / start.bat / start.ps1 - 启动所有服务（前端、后端、MCP）用于本地开发。
docker-start.sh / docker-start.bat - 使用Docker容器启动所有服务。

MCP服务器脚本

check_mcp_health.sh - 验证MCP服务器的健康状况和配置状态。
restart_and_test_mcp.sh - 使用更新的MCP配置重启Docker容器并测试连接性。

Crawl4AI脚本

check_crawl4ai.sh - 检查Crawl4AI服务的状态和健康状况。
debug_crawl4ai.sh - 在调试模式下运行Crawl4AI，带有详细的日志记录以供故障排除。
test_crawl4ai.py - 对Crawl4AI服务进行测试，验证其功能。
test_from_container.sh - 从Docker容器内测试Crawl4AI服务。

实用脚本

view_result.sh - 以格式化的视图显示爬取结果。
find_empty_folders.sh - 在项目结构中识别空目录。
analyze_empty_folders.sh - 分析空文件夹并按风险等级分类。
verify_reorganization.sh - 验证代码重组是否成功。

这些脚本组织在以下目录中：

根目录：主要脚本用于常见操作
scripts/general/：通用实用脚本
scripts/docker/：Docker专用脚本
scripts/mcp/：MCP服务器管理脚本
scripts/test/：测试和验证脚本

🌍 由开发者为开发者打造

DevDocs不仅仅是一款工具——它是您的文档伴侣，它：

节省时间：将数周的研究时间缩短到数小时
提高理解：获得干净、有组织的文档
促进创新：使用任何技术更快地构建
支持团队：高效共享知识
LLM准备就绪：现代时代需要现代解决方案，使用DevDocs与LLM非常容易且直观。只需最小的配置，您就可以运行DevDocs和Claude App，并识别DevDocs的MCP服务器，随时与您的数据聊天。

🛠️ 设置Cline/Roo Cline以实现快速软件开发。

打开“模式”界面
- 在Roo Code中，点击**+**创建新的模式特定提示。 <br>
命名
- 给模式一个名称（例如，Research_MCP）。 <br>
角色定义提示

专业知识和个性：专业知识：开发者文档检索、技术综合和文档搜索。个性：系统化、注重细节和精准。提供结构良好的答案，并明确引用文档部分。

行为准则：始终使用目录和章节访问工具来解决任何关于MCP文档的查询。保持回答的清晰、准确和可追溯性。

</details> <br>

模式特定自定义指令提示

1. 目录工具：返回完整的或过滤的文档主题列表。
2. 章节访问工具：检索特定文档章节的详细内容。

一般流程：查询解释：解析用户的查询，提取关键主题、关键词和上下文。从查询中识别可能的相关部分（例如，API配置、错误处理）。

通过目录发现：使用目录工具搜索文档索引中的相关部分。筛选或扫描标题和元数据以匹配关键词。

深入使用章节访问：对于每个识别的相关文档或章节，使用章节访问工具检索其内容。如果需要多个部分，则请求所有相关章节以确保全面覆盖。

综合与响应形成：结合检索的内容，形成连贯且完整的答案。引用章节标识符或文档路径以确保可追溯性。验证查询的每个方面都得到了解答。

错误处理：如果没有找到匹配的部分，调整搜索参数并重试。清楚报告如果查询仍然模糊或没有相关的文档可用。

强制工具使用：
执行：每当收到需要从MCP服务器文档中获取信息的查询时，代理必须首先查询目录工具以列出潜在的相关主题，然后使用章节访问工具检索必要的详细内容。

搜索与检索工作流：
解析和隔离：从用户的查询中识别关键术语和数据点。

索引查找：立即查询目录工具以获取相关文档部分的列表。

针对性检索：对于每个有希望的部分，使用章节访问工具获取完整内容。

信息综合：合并检索的内容，确保包含所有必要细节并明确引用。

回退和澄清：如果初始搜索未能产生足够的数据，调整查询参数并检索额外的部分。

自定义指令加载：特定于Research_MCP模式的附加自定义指令可以从工作区中的.clinerules-research-mcp文件加载。这些可能包括基于不断发展的文档结构或查询类型的进一步细化或约束。

最终输出构造：最终答案应组织良好，直接回应查询，并包括清晰的指针（例如，章节名称或标识符）回到MCP文档。确保最小冗余的同时涵盖所有必要细节。