ProjectWiki – 智能项目知识助手

ProjectWiki 是一个智能项目知识助手，从静态文档管理升级为动态智能交互系统。支持基础文档生成（README/ROADMAP/CHANGELOG/ARCHITECTURE）、文档流程管理（生成/更新/修改/完善）、文档一致性保障、版本控制。

核心价值

让文档生成自动化、规范化、一致性

• 基础文档：每个项目必备的核心文档清单
• 流程管理：完整的文档生成/更新/修改/完善流程
• 一致性保障：数据一致性、术语一致性、功能名称一致性
• 版本控制：完整的 CHANGELOG 管理
• 按需扩展：根据项目类型和复杂度按需生成其他文档
• 知识积累：自动搜索并积累技术知识到知识库

智能工作流程

Agent 通过自然语言与用户交互，结合模板和指南完成文档工作。

核心能力

1. 知识搜索

• 使用 web_search 搜索不熟悉的技术栈知识
• 整理知识内容并保存到 wiki/references/ 目录
• 参考: 知识搜索指南

2. 一致性检查

• 检查文档与代码的一致性（版本、API、配置等）
• 确保术语、功能、状态在各文档间保持一致
• 参考: 一致性检查指南

3. 生命周期管理

• 管理文档从创建到归档的完整生命周期
• 6 种状态：Draft → Review → Published → Maintenance → Archived → Deprecated
• 参考: 生命周期管理指南

关键特性

1. 渐进式文档系统

从功能描述到架构设计的完整文档链，支持自动推断和数据一致性设计。

功能文档 → 需求文档 → 架构文档

核心重点：

• 数据流动（Mermaid 时序图）
• 状态管理（完整的状态机设计）

2. 智能推荐引擎

基于项目分析结果，自动推荐最合适的文档类型和模板。

推荐维度：

• 项目类型（Django、React、Flutter 等）
• 复杂度（简单、中等、复杂）
• 角色视图（架构师、开发者、测试、运维、产品）

3. 渐进式知识搜索

项目级能力，自动搜索并积累不熟悉的技术栈知识。

知识类型：库、架构、设计模式、原理、数学公式

4. 数据流动设计

强调数据在系统中的流动路径，使用时序图和流程图可视化。

5. 状态管理

提供完整的状态机设计框架，强调状态一致性和状态持久化。

6. 文档生命周期 ⭐ 新增

管理文档从创建到归档的完整生命周期。

生命周期阶段：

• 🟡 Draft（草稿）
• 🟠 Review（审核）
• 🟢 Published（发布）
• 🔵 Maintenance（维护）
• 🟣 Archived（归档）
• 🔴 Deprecated（废弃）

核心功能：

• 状态转换管理
• 审查流程跟踪
• 版本历史记录
• 过期文档检查

快速开始

一、创建基础文档

1. 根据项目类型选择模板：references/templates/core/
2. 生成 README.md、ROADMAP.md、CHANGELOG.md、ARCHITECTURE.md
3. 设置文档元信息（作者、版本、状态）

二、搜索知识

遇到不熟悉的技术时，使用 web_search 搜索并保存到 wiki/references/

参考：知识搜索指南

三、一致性检查

发布前检查文档与代码的一致性

参考：一致性检查指南

文档规范化

核心文档命名

命名规范：

• ✅ 必须使用全大写
• ✅ 必须位于项目根目录
• ✅ 必须使用 .md 扩展名

详细规范：文档命名规范

目录结构

project-wiki/
├── SKILL.md                      # 本文件
├── references/
│   ├── core/                     # 核心指南
│   ├── templates/                # ⭐ 文档模板（按类型分类）
│   │   ├── core/                 # 核心文档
│   │   ├── api/                  # API 文档
│   │   ├── architecture/         # 架构文档
│   │   ├── database/             # 数据库文档
│   │   ├── usecase/              # 用例文档
│   │   ├── lifecycle/            # 生命周期文档
│   │   └── ...
│   ├── guides/                    # 指南文档
│   │   ├── document/             # 文档指南（⭐ 知识搜索、一致性检查、生命周期管理）
│   │   ├── architecture/         # 架构指南
│   │   ├── database/             # 数据库指南
│   │   └── usecase/              # 用例指南
│   ├── knowledge/                # 知识库
│   │   ├── patterns/             # 设计模式
│   │   ├── principles/           # 设计原则
│   │   ├── framework/            # 框架知识
│   │   ├── extraction.md        # 知识提取
│   │   ├── knowledge-graph.md   # 知识图谱
│   │   └── management.md         # 知识管理
│   └── tools/                    # 工具指南
│       ├── smart-analysis.md     # 智能分析
│       └── structure-optimization.md  # 结构优化

资源索引

核心指南

工具指南

知识管理

参考文档

使用技巧

1. 使用模板生成文档

参考 references/templates/ 下的模板，根据项目类型选择合适的模板。

2. 遵循文档生成流程

使用 references/guides/document/generation-flow-guide.md 了解完整的文档生成流程，包括：

使用标准命名确保项目文档的一致性：

• README.md – 项目概述
• ROADMAP.md – 路线图
• CHANGELOG.md – 变更日志
• ARCHITECTURE.md – 架构文档

3. 参考文档生成流程

使用 references/guides/document/generation-flow-guide.md 了解完整的文档生成流程，包括：

• 场景：整体新项目Wiki、部分功能文档
• 操作：生成、更新、修改、完善
• 注意事项：一致性、版本控制、图文结合

4. 按需生成扩展文档

根据项目类型和复杂度，按需生成：

• API 文档（API 接口定义）
• 数据库 ER 图（数据模型）
• 用例图（功能用例）
• 软件生命周期（开发流程）

使用 --auto 参数让系统自动选择模板和内容。

5. 遵循文档生成流程

使用 references/guides/document/generation-flow-guide.md 确保文档生成流程完整。

6. 保障文档一致性

在生成/更新文档时，确保：

• 数据一致性（版本号、日期）
• 术语一致性（专业术语、缩写）
• 功能名称一致性（代码与文档一致）

7. 记录版本变更

每次文档变更必须更新 CHANGELOG.md，记录：

• 版本号
• 变更日期
• 变更类型（新增/修改/删除/修复）
• 变更描述

常见问题

Q: 核心文档如何命名？ A: 必须使用全大写：README.md、ROADMAP.md、CHANGELOG.md、ARCHITECTURE.md

Q: 哪些是基础文档？ A: 基础文档包括：README.md（项目概述）、ROADMAP.md（路线图）、CHANGELOG.md（变更日志）、ARCHITECTURE.md（架构文档）。详见 基础文档清单

Q: 如何生成文档？ A: 参考 文档生成流程指南，了解生成/更新/修改/完善的完整流程

Q: 如何搜索技术知识？ A: 使用 web_search 搜索技术栈知识，整理后保存到 wiki/references/ 目录。详见 知识搜索指南

Q: 如何管理文档生命周期？ A: 通过设置文档状态（Draft/Review/Published/Maintenance/Archived/Deprecated）管理文档。详见 生命周期管理指南

Q: 如何保证文档一致性？ A: 在生成/更新文档时检查：数据一致性（版本号、日期）、术语一致性、功能名称一致性。详见 一致性检查指南

Q: 模板在哪里？ A: 所有模板在 references/templates/，按类型分类

Q: 如何创建 ER 图？ A: 使用 references/templates/database/er-diagram.md 模板，参考 references/guides/database/er-diagram-guide.md

Q: 如何创建用例图？ A: 使用 references/templates/usecase/usecase-diagram.md 模板，参考 references/guides/usecase/usecase-guide.md

Q: 如何设计软件生命周期？ A: 使用 references/templates/lifecycle/software-lifecycle.md 模板

Q: 如何进行技术选型？ A: 参考 references/templates/architecture/tech-selection-reference.md 技术选型参考手册

Q: 如何设计系统架构？ A: 参考 references/guides/architecture/architecture-design-guide.md 架构设计指南

Q: 如何做出技术决策？ A: 参考 references/guides/architecture/tech-selection-guide.md 技术选型决策指南

更新日志

v2.6 – 文档目录规范 ⭐ 优化

• 不再使用 TODO.md，统一使用 ROADMAP.md 作为规划文档
• 所有扩展文档放在 wiki/ 目录下
• 更新基础文档清单和流程指南
• 移除 templates/core/TODO.md 模板

v2.5 – 基础文档与流程指南 ⭐ 新增

• 新增文档生成流程指南
• 新增基础文档清单
• 明确基础文档定义（README/ROADMAP/CHANGELOG/ARCHITECTURE）
• 定义文档操作情景（生成/更新/修改/完善）
• 添加一致性保障指南
• 添加版本控制规范

v2.4 – 架构设计能力 ⭐ 新增

• 新增技术选型参考手册
• 新增架构设计指南
• 新增技术选型决策指南
• 新增用例图模板和指南
• 新增软件生命周期模板
• 支持全面项目文档撰写能力
• 支持根据项目目标、内容和复杂度智能选择文档实现程度

v2.2 – 文档生命周期管理 ⭐ 新增

• 新增文档生命周期管理能力
• 新增 6 个文档状态（Draft、Review、Published、Maintenance、Archived、Deprecated）
• 新增生命周期管理脚本（lifecycle_manager.py）
• 新增文档生命周期指南和模板
• 支持状态转换、审查流程、版本管理

v2.1 – 模板库优化

• 重组 templates 目录，按文档类型分类
• 新增 12 个模板分类
• 精简 SKILL.md 到 200 行

v2.0 – 智能自主性增强

• 新增智能分析器
• 新增自动推荐功能
• 重组目录结构
• 新增设计原则文档

v1.0 – 基础版本

• 项目分析
• 文档生成
• 知识查询
• 角色视图