DeepWiki 文档生成 Skill

Generate structured DeepWiki technical documentation from source files with Mermaid diagrams.

Updated Apr 15, 2026
One-click install
npx skills add https://github.com/AoManoh/project_templates --skill deepwiki-skill-aomanoh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: DeepWiki 文档生成 Skill
Source: https://github.com/AoManoh/project_templates/tree/main/skills/deepwiki
Command: npx skills add https://github.com/AoManoh/project_templates --skill deepwiki-skill-aomanoh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

DeepWiki 文档生成 Skill 解决的是:把软件项目的代码事实转化为结构化、可复盘、可检索的技术文档,避免文档只存在于聊天上下文里而缺少证据链与一致格式。

Core Features & Use Cases

  • 项目类型分析与组织模式选择:先判定项目类型与推荐组织模式,决定文档章节骨架(并给出置信度与章节建议)。
  • 按章节映射源码并生成正文:为每个章节提取相关源文件,生成“相关源文件”“目的与范围”等必备内容,并在需要时引用源码行号。
  • 自动产出中文 Mermaid 图表并做质量检查:为架构/流程/交互等复杂信息生成中文标注图表,并执行质量检查以确保结构完整、语言与格式符合 SPEC。

Quick Start

请触发 deepwiki 生成项目的技术文档,并确保项目根目录的 AGENTS.md 与 docs/deepwiki/ 作为输出目标已就位。

Frequently Asked Questions about DeepWiki 文档生成 Skill

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate structured technical documentation from source code?

Generating structured technical documentation from source code requires analyzing the project type, selecting an organization mode, extracting chapter-relevant source files, and writing evidence-based content with source code line number references.

What is evidence-based writing for software architecture overviews?

Evidence-based writing for software architecture overviews means mapping documentation chapters directly to extracted source files, ensuring technical claims are backed by verifiable code references rather than existing solely in chat context.

How do I create Mermaid diagrams for technical documentation automatically?

Creating Mermaid diagrams for technical documentation automatically involves generating Chinese-annotated charts for architecture and process flows, followed by quality checks to ensure structural completeness and SPEC format compliance.

Can I enforce spec compliance for project documentation outputs?

Yes, you can enforce spec compliance for project documentation by applying SPEC.md language and format rules during generation, executing post-generation quality checks, and enforcing output paths relative to the AGENTS.md project root.

What is the best way to map source code files to documentation chapters?

The best way to map source code files to documentation chapters is to determine the project type and organization mode first, then extract chapter-specific source files to populate required sections like purpose and scope with verifiable references.

Do I need an AGENTS.md file to output DeepWiki technical docs?

Yes, you need an AGENTS.md file in the project root directory to establish the output target, alongside the docs/deepwiki/ path, ensuring the generated technical documentation maintains correct relative pathing and evidence chains.