SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillsproject-wiki

project-wiki

General & other

View repository

Updated 10-16 01:19

About this skill

ProjectWiki - Intelligent Project Knowledge Assistant

ProjectWiki is an intelligent project knowledge assistant that supports basic document generation, document process management, and knowledge base queries.

Core Capabilities

  1. Basic Document Generation: README、ROADMAP、CHANGELOG、ARCHITECTURE
  2. Document Process Management: Generate, update, modify, and improve documents, including document management processes, reviews, and health checks
  3. Knowledge Base Queries: Quick reference for technical frameworks, design patterns, and best practices
  4. Document Consistency Checks: Terminology naming, content logic, format structure, data parameters, chart text, role permissions, timeline
  5. Project Type Documentation Guides: Differentiated documentation recommendations for frontend, backend, full-stack, mobile, desktop, CLI/TUI, and game projects
  6. Document Management Process: 6-phase lifecycle management, role responsibilities, review checklist, toolchain recommendations

Three-Step Workflow

Step 1: Gather Information

  1. Read the project structure and existing documents
  2. Query the knowledge base for technical information
  3. Identify the project type (frontend/backend/full-stack/mobile/desktop/CLI/TUI/game)
  4. Determine the types of documents that need to be generated

Step 2: Perform Operations

  1. Select appropriate document templates and guides based on the project type
  2. Write document content according to the guides
  3. Use Mermaid to draw diagrams

Step 3: Check and Accept

  1. Verify document completeness
  2. Run consistency checks (7 major categories of check items)
  3. Check document completeness based on the project type
  4. Confirm format specifications
  5. Generate a check report

Reference Documents

Documentation Guides

Document Purpose When to Use
guides/README.md Documentation Writing Guide Index Before writing any document
guides/architecture-doc-guide.md Architecture Documentation Guide When writing ARCHITECTURE.md
guides/design-doc-guide.md Design Documentation Guide When writing design documents
guides/functional-doc-guide.md Feature Documentation Guide When writing feature documents
guides/api-doc-guide.md API Documentation Guide When writing API documents
guides/cicd-guide.md CI/CD Documentation Guide When writing deployment documents
guides/changelog-guide.md Changelog Guide When writing CHANGELOG
guides/roadmap-guide.md Roadmap Guide When writing ROADMAP
guides/consistency-check-guide.md Consistency Check Guide During document quality checks

Project Type Guides

Document Purpose When to Use
guides/frontend-project-guide.md Frontend Project Documentation Guide Vue/Svelte/SolidJS projects
guides/backend-project-guide.md Backend Project Documentation Guide FastAPI/Gin/Spring Boot projects
guides/fullstack-project-guide.md Full-Stack Project Documentation Guide Frontend-backend separated projects
guides/mobile-project-guide.md Mobile Project Documentation Guide Flutter projects
guides/desktop-project-guide.md Desktop Project Documentation Guide Tauri/Wails/C#/Electron projects
guides/cli-tui-project-guide.md CLI/TUI Project Documentation Guide Command-Line Tool Project
guides/game-project-guide.md Game Project Documentation Guide Godot Game Project

Documentation Management

Documentation Purpose When to Use
guides/document-management-guide.md Documentation Management Process When establishing a documentation management process
guides/document-health-check-guide.md Health Check When checking documentation health
guides/document-management-anti-patterns.md Anti-Pattern Warnings When identifying documentation management issues

Documentation Templates

Documentation Purpose When to Use
templates/README.md Documentation Template Index When selecting a template
templates/ARCHITECTURE.md Architecture Documentation Template Generate ARCHITECTURE.md
templates/CHANGELOG.md Changelog Template Generate CHANGELOG.md
templates/ROADMAP.md Roadmap Template Generate ROADMAP.md
templates/consistency-checklist-template.md Consistency Check Checklist Perform consistency check
templates/rtm-template.md Requirements Traceability Matrix Requirements - Design - Test Alignment
templates/document-review-checklist.md Documentation Review Checklist During documentation review
templates/lightweight-doc-management-process.md Lightweight Process When small and medium teams need quick implementation

Knowledge Base

Documentation Purpose When to Use
knowledge/README.md Knowledge Base Index When querying the knowledge base
knowledge/frameworks.md Framework Quick Reference During technology selection
knowledge/patterns.md Design Pattern Quick Reference During architecture design
knowledge/principles.md Design Principles During object-oriented design
knowledge/consistency-rules.md Consistency Rules Understand check rules and automation suggestions
knowledge/project-type-recognition.md Project Type Identification When identifying the project type
knowledge/document-management-tools.md Toolchain Guide When selecting documentation management tools

Documentation Type Quick Reference

Documentation File Name Purpose
README README.md Project introduction and quick start
ROADMAP ROADMAP.md Project planning and milestones
CHANGELOG CHANGELOG.md Version change record
ARCHITECTURE ARCHITECTURE.md System architecture design
API Documentation wiki/api.md API interface description
Design Documentation wiki/design.md Detailed design description

Usage Examples

Example 1: Generate Project Documentation

Requirement: Generate complete documentation for a new project

Step 1: Consult Information

1. 分析项目结构
   - 项目类型: Web应用
   - 技术栈: React + FastAPI
   - 复杂度: 中等

2. 查询知识库
   - 阅读 [knowledge/frameworks.md](references/knowledge/frameworks.md)
   - 了解 React 和 FastAPI 最佳实践

Step 2: Perform Operations

1. 生成 README.md
   - 使用 [templates/README.md](references/templates/README.md)
   - 填写项目信息

2. 生成 ARCHITECTURE.md
   - 使用 [templates/architecture.md](references/templates/architecture.md)
   - 绘制系统架构图

3. 生成 ROADMAP.md
   - 使用 [templates/ROADMAP.md](references/templates/ROADMAP.md)
   - 规划开发里程碑

Step 3: Check Acceptance

□ 所有必需文档已生成
□ 文档格式符合规范
□ 图表清晰可读
□ 链接全部有效

检验结果: ✅ 通过

Example 2: Consistency Check Before Version Release

Requirement: Perform a documentation consistency check before releasing version v5.0.0

Step 1: Consult Information

1. 确定检查范围
   - 核心文档：SKILL.md, README.md, CHANGELOG.md, ROADMAP.md
   - 版本相关：版本号、发布日期、Git Tag

2. 准备检查工具
   - 一致性检查清单
   - 版本检查脚本

Step 2: Perform Check

1. 版本号一致性检查
   - SKILL.md: version: 5.0.0
   - CHANGELOG.md: ## [5.0.0] - 2024-02-20
   - Git Tag: v5.0.0
   ✅ 版本号一致

2. 日期格式检查
   - 所有日期使用 YYYY-MM-DD 格式
   ✅ 日期格式正确

3. 使用检查清单逐项检查
   - 术语与命名：✅
   - 内容逻辑：✅
   - 格式与结构：✅
   - 数据与参数：✅
   - 图表与文字：✅
   - 角色与权限：✅
   - 时间与进度：✅

Step 3: Generate Report

一致性检查报告：
- 检查日期：2024-02-20
- 检查项数：108
- 通过数：108
- 通过率：100%
- 结论：✅ 通过，可以发布

检验结果：✅ 通过

Example 3: Consistency Check After Requirements Change

Requirement: Requirement REQ-003 has changed; check the consistency of related documentation

Step 1: Consult Information

1. 识别变更影响
   - 需求文档：REQ-003 密码重置功能
   - 影响文档：设计文档、API 文档、测试用例

2. 准备追踪矩阵
   - 查看 RTM 中 REQ-003 的关联

Step 2: Perform Check

1. 更新需求文档
   - 修改 REQ-003 描述
   - 更新优先级和验收标准

2. 同步更新设计文档
   - 更新 3.2.3 章节
   - 修改流程图和接口定义

3. 更新 API 文档
   - 修改 /api/reset-password 接口
   - 更新请求/响应示例

4. 更新测试用例
   - 修改 TC-011~TC-015
   - 添加新的测试场景

5. 验证一致性
   - 使用 RTM 验证需求 - 设计 - 测试对齐
   - 运行一致性检查脚本

Step 3: Verify Results

RTM 更新后状态：
| 需求 ID | 设计章节 | 实现模块 | 测试用例 | 状态 |
|---------|---------|---------|---------|------|
| REQ-003 | 3.2.3 ✅ | UserController.resetPassword ✅ | TC-011~015 ✅ | 已验证 ✅ |

检验结果：✅ 通过

Notes

  • Standardization first: All documents follow project specifications
  • Progressive improvement: Start with core documents and improve gradually
  • Maintain consistency: Ensure terminology, versions, and configurations are consistent across documents
  • Update promptly: Update documentation in sync when code changes
  • Verify regularly: Consistency checks must be performed before version releases and after requirement changes
  • Use tools: Make full use of automated inspection tools to improve efficiency
  • Document review: Changes to important documents require peer review and consistency checks