mcpField
S
showcase

showcase

github.com/angusfretwell文档处理138 次安装1 天前更新
代码仓库

关于 showcase

showcase 是用于规划技术展示页面内容与叙事顺序的技能,面向产品和架构说明。它按论点选择文本、图表或界面截图作为证据,并将定稿简报交给 /to-artifact 发布。

主要功能

  1. 01确定主题与展示范围
  2. 02按叙事顺序组织论点
  3. 03为论点选择合适媒介
  4. 04规划并采集界面截图
  5. 05编写交付给 /to-artifact 的简报

适用场景

  1. 01编排功能演示页面
  2. 02制作架构概览
  3. 03说明缺陷成因与修复

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/angusfretwell/skills --skill showcase

安装后在 Claude Code 中输入/showcase确认已加载。

详细介绍

交付成果是一篇叙事:由一系列要点组成,每个要点都用最能证明它的媒介来呈现——用文本形状说明_它是如何构建的_,用图表说明_它如何流转_,用截图展示_你能看到什么_。每张视觉素材都是一份证明:用最精简的视图阐明要点,不添枝加叶。面向产品和架构来撰写;只有当代码本身是主题时,才深入代码。

此技能决定页面上呈现什么。/to-artifact 负责编排并发布内容,第 4 步的简报是交接内容。用户明确点名要求的媒介,优先于下方所有默认选择。

1. 确定主题

从第一个包含主题的来源中提取主题:调用中指定的内容、本次会话讨论的主题,或用户链接的 PR 或 issue。如果所有来源都没有内容,就提问。

完成标准:主题写成一行。

2. 确定要点范围

推导页面将涵盖的要点列表,以及承载这些要点的顺序。顺序应由主题决定。以下是常见主题,可作为起点:

功能演示——先介绍功能的作用,最后才深入说明其构建方式(如果需要)。说明它是什么,以及它为谁解决什么问题。逐步呈现使用历程,每个步骤配一张截图。用一张图说明流程,并标出真实的屏幕和状态。说明功能所在位置,并在文件引用中列出入口点。

架构概述——介绍整体结构,说明各组成部分及其整体作用。用数据流图或序列图展示主要路径。逐一说明各部分的职责、输入、输出和入口点。说明系统与外部交互的边界,以及每个边界传递的内容。

Bug 剖析——描述 Bug 时用过去时,描述修复时用现在时。说明用户看到的症状;如果 Bug 在屏幕上可见,就用复现故事板呈现。说明其机制:失败路径、实际状态,以及行为发生偏差的分支。用文字说明修复,并附上代码引用链接。最后用同一流程展示修复后的效果。

如果主题适合多种顺序,就用具体候选项提问一次(AskUserQuestion,multiSelect),候选项应根据主题拟定。如果顺序显而易见,就跳过提问。无论如何,这都是最后一个关于涵盖内容的问题。

完成标准:按顺序确定所有要点。

3. 收集素材

形态——选择最能证明各项观点的形态。对于分支很重要、语法不重要的逻辑,使用伪代码。对于运行时控制流,使用调用树,展示调用顺序和调用关系。对于 UI 结构,使用组件树,呈现重要的状态和模块边界。对于文件职责或大范围重构的整体形态,使用文件树,为每个条目写一行用途说明。当周边结构已存在时,用差异展示改动,并使差异的形态与主题相匹配——UI 改动用组件树,调用顺序改动用调用树。对于组件交互、数据流和状态机,使用图表,并遵循 /artifact-diagramming 绘制:标注真实状态、真实名称和真实分支条件,并为箭头标明流动内容。

屏幕截图——对于会渲染的主题,截图记录整个过程。用图表代替应用本可展示的屏幕,是一种缺陷。

调用 /run 启动应用,然后从该 URL 开始操作流程,优先为每个流程分配一个子 Agent:各个流程并行运行,日志也不会进入你的上下文。按顺序为每个步骤截一张图,并记录用户刚刚做了什么以及屏幕上发生了什么变化。截图会保存为磁盘上的文件,并作为支持文件传到页面,因此像素也不会进入你的上下文。发送前调整每张截图的尺寸并压缩。每个流程的 Agent 在截图保存到磁盘后关闭浏览器会话;所有流程完成后,如果 /run 启动了应用,就停止应用。

如果无法生成计划中的截图——应用无法启动,或无法操作流程——请停止并询问,同时提供不含截图的页面作为选项。

研究——首先参考本次会话自身的上下文。除此之外,根据范围决定:需要了解机制的观点,调用 /how;需要了解动机的观点,调用 /why。UI 流程通常两者都不需要。两者都会广泛展开(/how 会针对每个角度派出一个探索者,/why 会针对每个来源派出一名调查员,然后由一名综合者汇总),因此只在观点确实需要时调用。

每个观点都有对应素材后,即告完成。

4. 编写简报并发布

将简报写入暂存区,作为唯一一份确定 /to-artifact 要构建内容的文档:

# Brief: <subject>

The subject, points, and media below are settled. Take them as given, and start at framing the reader's job.

## Subject

<one line>

## Points

1. <what this point proves> — capture — `shots/01-signin.png`
2. <what this point proves> — sequence diagram
3. <what this point proves> — prose with file references

## Media

Publish these as supporting files:

- `shots/01-signin.png` — <what it shows, and what the reader just did>

派遣一个新的 Agent,传入简报的路径并调用 /to-artifact。简报就是它的全部上下文。

用户拿到链接后,即告完成。

评论

支持 Markdown