AI SummaryGenerate professional-grade structured project Wiki to directory. 1. 完整可运行：包含 import、初始化、调用、结果处理 2. 覆盖导出接口：每个主要导出 API 至少 1 个示例
Install
Copy this and paste it into Claude Code, Cursor, or any AI assistant:
I want to install the "mini-wiki" skill in my project. Please run this command in my terminal: # Install skill into your project mkdir -p .claude/skills/mini-wiki && curl --retry 3 --retry-delay 2 --retry-all-errors -o .claude/skills/mini-wiki/SKILL.md "https://raw.githubusercontent.com/trsoliu/mini-wiki/main/SKILL.md" Then restart Claude Code (or reload the window in Cursor) so the skill is picked up.
Description
Automatically generate **professional-grade** structured project Wiki from documentation, code, design files, and images. Use when: - User requests "generate wiki", "create docs", "create documentation" - User requests "update wiki", "rebuild wiki" - User requests "list plugins", "install plugin", "manage plugins" - Project needs automated documentation generation Features: - Smart project structure and tech stack analysis - **Deep code analysis** with semantic understanding - **Mermaid diagrams** for architecture, data flow, dependencies - **Cross-linked documentation** network - Incremental updates (only changed files) - Code blocks link to source files - Multi-language support (zh/en) - **Plugin system for extensions** For Chinese instructions, see references/SKILL.zh.md
Structure Requirements
• Use hierarchical headings (H2/H3/H4) for clear information architecture • Important concepts in tables for quick reference • Processes visualized with Mermaid diagrams • Cross-links between related documents
Diagram Requirements (minimum 2-3 per document)
| Content Type | Diagram Type | |--------------|--------------| | Architecture | flowchart TB with subgraphs | | Data/Call flow | sequenceDiagram | | State changes | stateDiagram-v2 | | Class/Interface | classDiagram with properties + methods | | Dependencies | flowchart LR |
🔴 Code Examples (Target: AI & Architecture Review)
文档主要受众是 AI 和架构评审，代码示例必须： • 完整可运行：包含 import、初始化、调用、结果处理 • 覆盖导出接口：每个主要导出 API 至少 1 个示例 • 包含注释说明：解释关键步骤和设计意图 • 适配项目语言：遵循语言最佳实践 `typescript // ✅ 好的示例：完整、可运行、有注释 import { AgentClient } from '@editverse/agent-core'; // 1. 创建客户端（展示必需配置） const agent = await AgentClient.create({ provider: 'openai', model: 'gpt-4', }); // 2. 基础对话 const response = await agent.chat({ messages: [{ role: 'user', content: '你好' }], }); console.log(response.content); // 3. 错误处理 try { await agent.chat({ messages: [] }); } catch (error) { if (error.code === 'INVALID_MESSAGES') { console.error('消息列表不能为空'); } } ` 示例类型根据导出 API 数量动态调整： | 导出数量 | 示例要求 | |----------|----------| | 1-3 | 每个 API 1 个基础示例 + 1 个错误处理 | | 4-10 | 核心 API 各 1 个示例 + 1 个集成示例 | | 10+ | 分类示例（按功能分组） |
Wiki Generator
Generate professional-grade structured project Wiki to .mini-wiki/ directory. > 核心原则：生成的文档必须 详细、结构化、有图表、相互关联，达到企业级技术文档标准。
Discussion
Health Signals
My Fox Den
Community Rating
Sign in to rate this booster