dewey

为AI智能体准备文档的工具包,提供审计、评分与生成功能。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:dewey。
它的用途是:为AI智能体准备文档的工具包,提供审计、评分与生成功能。
完整的 Skill 内容见:https://321skill.com/skills/dewey/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“帮我在项目中初始化Dewey文档结构并生成AI就绪文件。”,它会引导你运行`bunx dewey init`和`bunx dewey generate`命令,创建AGENTS.md等文件。然后你可以说:“评估一下我文档的AI就绪度。”,它会运行`bunx dewey agent`,给你一个0-100的评分和改进建议。

介绍

Dewey是一个专为AI智能体准备的文档工具包,它不只是一个文档框架,更是一个“文档智能体”。它专注于评估和优化你的项目文档,使其更适合被AI(如Claude、GPTs)理解和检索。

Dewey通过一系列CLI命令工作:首先用dewey init初始化文档结构,然后用dewey generate生成一系列AI友好的文件(如AGENTS.md、llms.txt、结构化docs.json),接着用dewey auditdewey agent来审计文档完整性并给出0-100分的“智能体就绪度”评分。它还能根据你的Markdown文档,一键生成一个独立的静态文档网站。

它非常适合需要与AI协作的开发者、文档工程师和项目经理。无论是为内部团队创建知识库,还是为外部开发者提供API文档,Dewey都能确保你的文档不仅是给人看的,也是给AI“读”的。

使用建议是,如果你的项目文档需要被频繁用于AI问答、代码生成或自动化流程,Dewey能系统化地提升其可用性。注意,它的核心价值在于“准备”文档,而非替代写作。对于纯静态、无需AI交互的简单文档项目,可能显得过于复杂。

核心特点

与普通文档生成器不同,Dewey的核心是“为AI智能体准备文档”,它通过专门的审计、评分体系(agent-readiness score)和生成AGENTS.md、llms.txt等特定格式文件,直接优化文档对LLM的友好度。它生成的`agent/`检索表面(如manifest.json, prompts.json)是专为AI检索设计的结构化数据,而非仅面向人类的网页。

注意事项

对于仅需简单、一次性生成静态网站,且无需与AI智能体交互的文档项目,使用Dewey可能引入不必要的复杂性。

常见问题

Dewey和VuePress/Docusaurus有什么区别?

Dewey核心是“文档智能体”工具,重点是为AI准备和评估文档(审计、评分、生成AI专用文件),静态网站生成是可选项。而VuePress/Docusaurus主要是面向人类的静态站点生成器。

Dewey必须生成一个网站吗?

不是。生成静态网站(`dewey create`)是完全可选的。核心功能是`dewey generate`生成的AGENTS.md、llms.txt、docs.json等AI就绪文件。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/dewey/raw/index.md 读取 dewey 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。