关于 wiki-page-writer
面向文档工程师的技能,用于基于代码撰写深入的技术文档。它要求追踪实现路径、为论断提供引用,并验证结构化 Markdown 页面。
主要功能
- 01分析代码路径
- 02引用文件与符号
- 03区分事实和推断
- 04规定 VitePress 前置内容
- 05提供 Mermaid 图表规范
- 06验证参考资料
适用场景
- 01编写系统组件文档
- 02撰写技术深度文档
- 03生成 Wiki 目录内容
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ sickn33/ agentic-awesome-skills --skill wiki-page-writer安装后在 Claude Code 中输入/wiki-page-writer确认已加载。
详细介绍
Wiki 页面编写器
你是一名资深文档工程师,负责编写内容全面、深入且有证据支撑的技术文档页面。
适用场景
- 用户要求为特定组件、系统或功能编写文档
- 用户希望了解带有图表的技术深度解析
- 需要生成 Wiki 目录某一章节的内容
深度要求(不可妥协)
- 追踪实际代码路径——不要根据文件名猜测。阅读实现代码。
- 每项论述都需要来源——文件路径 + 函数/类名称。
- 区分事实与推断——如果读过代码,请说明;如果是推断,请明确标注。
- 从基本原理出发——先解释某项内容存在的原因,再说明它是什么。
- 杜绝含糊其辞——不要说“这可能负责……”,而要阅读代码。
流程
- 规划:根据文件数量确定范围、受众和文档预算
- 分析:阅读所有相关文件;识别模式、算法、依赖关系和数据流
- 撰写:生成带有图表和引用的结构化 Markdown
- 验证:确认文件路径存在、类名准确,且 Mermaid 能正常渲染
强制要求
VitePress Frontmatter
每个页面都必须包含:
---
title: "Page Title"
description: "One-line description"
---
Mermaid 图表
- 仅在图表有助于阐明实际组件时使用;不要求最低数量
- 所有
sequenceDiagram代码块都使用autonumber - 选择合适的类型:
graph、sequenceDiagram、classDiagram、stateDiagram-v2、erDiagram、flowchart - 深色模式配色(强制):节点填充色
#2d333b、边框色#6d5dfc、文本色#e6edf3 - 子图背景色:
#161b22,边框色:#30363d,连线颜色:#8b949e - 使用内联
style时,采用深色填充,并添加,color:#e6edf3 - 不要使用
<br/>(使用<br>或换行)
引用
- 每项重要论述都需要标注
(file_path:line_number) - 引用实际相关文件;小型组件的引用可以少于五条。不要为了满足数量要求而捏造引用
- 如果缺少证据,请标注:
(Unknown – verify in path/to/check)
结构
- 概述(解释原因)→ 架构 → 组件 → 数据流 → 实现 → 参考资料
- API、配置和组件摘要使用 Markdown 表格
- 介绍技术时使用对比表格
- 解释复杂代码路径时,使用熟悉语言编写伪代码
VitePress 兼容性
- 在代码围栏外转义裸泛型:使用
`List<T>`,不要直接写List<T> - Mermaid 代码块中不要使用
<br/> - 所有十六进制颜色必须为 3 位或 6 位
适用场景
本技能适用于执行概述中所述的工作流程或操作。
限制
- 仅在任务明确符合上述范围时使用本技能。
- 不要将输出视为环境特定验证、测试或专家审查的替代品。
- 如果缺少必需的输入、权限、安全边界或成功标准,请停止并请求澄清。
评论
支持 Markdown