ghoulvspol

HTML Effectiveness Skill — Documentation skill for Claude Code

Documentation community

Claude Code skill: Generate interactive HTML instead of markdown walls of text.

How to install HTML Effectiveness Skill

This entry records only its repository, not the path inside it, so there is no exact command to give. Open ghoulvspol/html-effectiveness-skill and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

What HTML Effectiveness Skill does

Claude Code skill: Generate interactive HTML instead of markdown walls of text. 9 output patterns, zero deps, browser-ready.

Alternatives in Documentation

  • Repo Recap — Generate a structured recap of the repository state: open PRs, open issues, recent releases, and executive sum 11.9k ★
  • Claude Code Ultimate Guide — by Florian BRUNIAUX - A tremendous feat of documentation, this guide covers Claude Code from beginner to power 2k ★
  • Docs Serve — Build the HTML documentation and then serve it locally so it can be viewed in a browser 1.1k ★

README

HTML Effectiveness Skill

**Markdown 是文字墙。HTML 是空间化、可交互的文档。**

当 AI agent 需要输出复杂信息(对比分析、时间线、决策矩阵、数据表格、代码审查)时,生成一个自包含的 HTML 文件,让读者在浏览器中扫描、过滤、探索、交互,而不是在 markdown 中上下滚动寻找信息。

灵感来源: [The Unreasonable Effectiveness of HTML](https://thariqs.github.io/html-effectiveness/)


这是什么

一个 Claude Code skill,指导 AI agent 在输出复杂内容时,生成单文件、零依赖、可直接在浏览器打开的交互式 HTML 文档。

**核心理念:** 信息应该是空间化的、可扫描的、可交互的,而不是线性的文字墙。

何时使用

场景 输出格式
比较 2+ 个方案的优劣 HTML 对比看板
展示 >5 行数据 HTML 可排序表格
时间线、项目进度 HTML 时间线
多维度决策 HTML 决策矩阵
概念解释、教学 HTML 知识探索器
代码审查、PR review HTML 审查板
系统架构、设计 HTML 架构图
简单问答、一行修复 纯 markdown

9 种输出模式

1. Comparison Board (对比看板)

并排卡片展示多个选项,标签区分优劣,推荐高亮。

2. Annotated Timeline (时间线)

垂直时间线,颜色区分状态(完成/进行中/待开始),可展开详情。

3. Interactive Report (交互报告)

顶部统计 + 分类过滤按钮 + 卡片式详情,支持搜索。

4. Code Review Board (代码审查板)

按文件分组,严重度标签,前后对比 diff,行内评论。

5. Decision Matrix (决策矩阵)

选项为列,评估维度为行,颜色深浅表示得分,表头排序。

6. Knowledge Explorer (知识探索器)

折叠面板 + 标签页代码示例 + 搜索过滤 + 锚点导航。

7. Kanban Board (看板)

拖拽卡片在列间移动,支持导出为 markdown。

8. Design Token Sheet (设计系统)

色板点击复制 hex 值,字体比例尺,间距参考。

9. Slide Deck (幻灯片)

方向键导航,最小 JS,无需导出。

快速开始

安装为 Claude Code Skill

将 `skill.md` 复制到 Claude Code 的 skills 目录:

# 方法 1: 直接克隆到 skills 目录
git clone https://github.com/ghoulvspol/html-effectiveness-skill.git ~/.claude/skills/html-effectiveness

# 方法 2: 手动复制
mkdir -p ~/.claude/skills/html-effectiveness
cp skill.md ~/.claude/skills/html-effectiveness/skill.md

在对话中使用

# 直接触发
/html-effectiveness

# 或在输出复杂分析结果时,AI 会自动匹配此 skill
"对比这 3 个技术方案的优劣" → 自动选择 Comparison Board
"列出项目里程碑和进度" → 自动选择 Timeline
"评估候选方案在各维度的表现" → 自动选择 Decision Matrix

生成的 HTML 特性

  • 单文件 — 所有 CSS/JS 内联,无外部依赖
  • 零构建 — 浏览器直接打开 file:// 或任何 HTTP 服务
  • 深色模式 — 自动跟随系统 prefers-color-scheme
  • 响应式 — 375px 手机到 1440px 桌面自适应
  • 可打印 — @media print 自动展开所有折叠内容
  • 语义化 — HTML5 + ARIA 属性,屏幕阅读器友好

设计规范

视觉系统

:root {
  --bg: #fa