All notable changes to this project will be documented in this file.
- Clarified instruction-only plugin model across docs (no code/script execution by agents)
- Removed CLI
runexamples from plugin docs and replaced with manual-only guidance - Updated plugin protocol wording to "apply guidance" instead of "execute"
- Removed TLS verification override from
scripts/plugin_manager.py - Removed bundled
plugins/agent-skills-mainfrom release package - Cleaned plugin registry and repacked
mini-wiki.skill
Major upgrade to project analysis capabilities:
- Detection: Automatically identifies Monorepo structures
- Tools:
turborepo,lerna,pnpm-workspaces,npm-workspaces,yarn-workspaces - Structure: Smartly analyzes
packages/andapps/directories
- Rust: Parses
Cargo.tomlto detect frameworks (actix-web,axum,tokio,tauri,rocket) - Go: Parses
go.modto detect frameworks (gin,echo,fiber,gorm) - Python: Enhanced
pyproject.tomlsupport (identifiespoetry,pdm,flitand frameworks likefastapi,django) - Node.js: Precise package manager detection (
npm,yarn,pnpm,bun)
质量标准不再是固定数字,而是基于模块复杂度动态计算
不同模块复杂度不同,固定标准不合理:
- 核心模块 (agent-core): 2000 行源码 → 期望 600+ 行文档
- 工具模块 (utils): 200 行源码 → 期望 80+ 行文档
- 配置模块 (constants): 50 行源码 → 期望 50+ 行文档
| 指标 | 计算公式 |
|---|---|
| 文档行数 | max(100, source_lines × 0.3 + exports × 20) |
| 代码示例 | max(2, exports × 0.5) |
| 图表数量 | max(1, ceil(files / 5)) |
| 章节数 | 6 + module_role_weight |
- 项目类型: frontend / backend / fullstack / library / cli
- 开发语言: TypeScript / Python / Go / Rust
- 模块角色: core (+4) / util (+2) / config (+1)
| 等级 | 说明 |
|---|---|
| 🟢 Excellent | 超过期望值 20%+ |
| 🟡 Good | 达到期望值 |
| 🟠 Acceptable | 达到期望值 80%+ |
| 🔴 Needs Work | 低于期望值 80% |
对标 Qoder 文档质量,三大核心改进:
wiki/
├── AI系统/
│ ├── Agent核心/
│ └── MCP协议/
├── 存储系统/
├── 编辑器/
└── 跨平台/
| 指标 | v3.0.4 | v3.0.5 |
|---|---|---|
| 最少行数 | 200 | 400 |
| 章节数 | 9 | 12 |
| 图表数 | 2 | 3 |
| 代码示例 | 3 | 5 |
每个文档必须包含 5 类示例:
- 基础用法
- 完整配置
- 错误处理
- 高级用法
- 跨模块集成
解决一次性生成多文档导致质量稀释的问题:
- 批次大小调整:从 5 个模块减少到 2-3 个模块/批次
- 质量门槛强化:每个文档 ≥200 行、≥9 章节、≥2 图表
- 每批质量检查:生成后自动运行
check_quality.py - 质量未达标处理:重新生成或补充缺失内容
- 用户交互改进:显示行数和质量等级
核心理念:Token 有限 → 减少批次大小 → 最大化单文档质量
新增文档质量自动检查系统:
- 新增
scripts/check_quality.py:自动化质量检查脚本- 检查行数、章节数、图表数、代码示例数
- 检查 classDiagram、源码追溯、必需章节
- 输出质量评估报告(Professional/Standard/Basic)
- 支持
--verbose详细报告和--json导出
使用方法:
python scripts/check_quality.py /path/to/.mini-wiki --verbose对比 Qoder 等竞品文档质量后,大幅强化文档生成标准:
- 🔴 源码追溯:每个章节末尾必须包含
Section sources和Diagram sources引用 - 🔴 classDiagram 强制:每个核心类/接口必须生成详细类图(含属性+方法)
- 🔴 模块文档结构:强制 9 个必需章节(概述、核心功能、最佳实践、性能优化、错误处理等)
- 🔴 最小行数要求:模块文档最少 200+ 行
- 图表要求提升:从 1-2 个提升到 2-3 个/文档
- Update Instructions: Added update section to README with npx, git, and .skill file methods
- FAQ Section: Added FAQ addressing common questions:
- Will updating delete existing docs? (No)
- How to upgrade low-quality docs? (Commands & quality levels)
- Will custom content be preserved? (Yes, with
<!-- user-content -->) - How to check doc quality? (
check wiki qualitycommand)
- UI Fix: All
<details>sections now expanded by default for better readability
本版本全面升级文档生成质量标准,从"基础文档"提升至"企业级专业文档"。
-
📋 文档质量标准体系
- 内容深度要求:完整上下文、详细说明、可运行示例
- 结构要求:层级标题、表格、Mermaid 图表、交叉链接
- 每个文档至少 1-2 个图表(架构图、流程图、状态图等)
- 文档关系网络:自动生成
doc-map.md
-
🔍 深度代码分析
- 新增代码语义分析步骤(不仅分析结构,还理解功能)
- 提取函数目的、参数、返回值、副作用
- 识别设计模式和数据流
- 生成模块依赖图和调用图
-
🚀 大型项目渐进式扫描
- 触发条件:模块 > 10 / 文件 > 50 / 代码行 > 10,000
- 批次划分 + 优先级排序 + 进度跟踪
- 断点续传:
继续生成 wiki命令 - 配置:
progressive.batch_size,progressive.auto_continue
-
🔄 文档升级刷新机制
- 版本检测:自动识别旧版本生成的文档
- 质量评估:basic / standard / professional 三级标准
- 升级策略:
refresh_all/upgrade_progressive/upgrade_selective - 命令:
检查 wiki 质量,升级 wiki,刷新全部 wiki
-
SKILL.md 重构(350 行 → 600+ 行)
- 新增"文档质量标准"章节
- 新增"深度代码分析"步骤
- 新增"大型项目渐进式扫描"章节
- 新增"文档升级刷新"章节
- 详细的内容生成规范(首页、架构、模块、API 各 10+ 要求项)
-
references/prompts.md 全面重写(130 行 → 577 行)
- 专业级 AI 提示词模板
- 强制内容深度和图表要求
- 代码深度分析提示词
-
references/templates.md 全面重写(279 行 → 1496 行)
- 专业级 Markdown 模板
- 内置 Mermaid 图表模板
- 16 章节模块文档模板
-
SKILL.zh.md 同步更新
-
api-doc-enhancer v2.0.0 → 专业级(124 行 → 620+ 行)
- 深度语义分析
- 3 层示例生成(基础、进阶、错误处理)
- API 关系图谱
- 大型项目渐进式扫描支持
- 文档升级支持
-
repo-analytics v2.0.0 → 专业级(125 行 → 640+ 行)
- 5 维分析(贡献者、演进、热点、协作、健康度)
- 健康度评分系统
- 协作网络图
- 风险热点识别
- 渐进式历史分析
-
patent-generator v2.0.0 → v3.0.0 专业级(155 行 → 454 行)
- 基于资深专利代理人经验重写
- 7 步标准专利交底书流程
- 符合《专利法实施细则》和《专利审查指南》
- 发明名称、技术领域、背景技术、发明目的、技术方案、有益效果、实施例
- 术语抽象化和禁用词汇检查
新增配置项:
generation:
detail_level: detailed # minimal / standard / detailed
min_sections: 10 # 每个模块文档最少章节数
diagrams:
architecture_style: flowchart TB
dataflow_style: sequenceDiagram
use_colors: true
linking:
auto_cross_links: true
generate_doc_map: true
generate_dependency_graph: true
progressive:
enabled: auto
batch_size: 5
auto_continue: false
upgrade:
auto_detect: true
backup_before_upgrade: true
preserve_user_content: true
min_quality: professional- 7 个内置插件:
code-complexity(分析器)paper-drafter(生成器) - NEWrepo-analytics(分析器) - NEWpatent-generator(生成器) - NEWapi-doc-enhancer(生成器)changelog-generator(生成器)diagram-plus(增强器)i18n-sync(增强器)docusaurus-exporter(格式/导出器)gitbook-exporter(格式/导出器)
- Skills.sh 兼容性增强:
- 支持通过
owner/repo简写安装 GitHub 上的插件 - 自动将通用 Skills (无 PLUGIN.md) 包装为 mini-wiki 插件
- 支持直接安装 skills.sh 上的任何 skill 作为增强能力
- 支持通过
- 插件管理增强:
- 新增
update命令支持插件版本更新 - Registry 支持记录插件来源元数据 (GitHub/URL)
- 新增
- SKILL.md: 增加了
Plugin Execution Protocol,强制 AI 在工作流中加载并执行插件指令 - README: 增加了对插件运行机制的说明
- 按 skills.sh 标准重构整个技能
- 增量更新支持(基于文件校验和)
- 多语言 Wiki 生成(
i18n/en/,i18n/zh/) - 代码块源码链接
[📄](file://...#L行号) - Mermaid 架构图自动生成
- 插件系统 (
plugins/目录)_registry.yaml插件注册表plugin_manager.py插件管理脚本- 支持 5 种钩子:on_init, after_analyze, before_generate, after_generate, on_export
- 支持从 URL 或本地路径安装插件
- 7 个 Python 辅助脚本
- 中英文分离的文档
- 输出目录改为
.mini-wiki/ - SKILL.md 精简至 ~150 行,遵循 Progressive Disclosure 原则
- 移除用户模型配置,Agent 使用自身模型生成内容
- 移除
examples/目录(遵循 skills.sh 规范) - 移除冗余模板文件
- 初始版本
- 基础 Wiki 生成功能
- 项目分析脚本
- 文档提取脚本