yulonghe97/build-plan

GitHub: yulonghe97/build-plan

一个 agent skill,能将技术计划和设计方案自动转化为带导航、SVG 图表和多语言支持的独立 HTML 页面。

Stars: 1 | Forks: 0

# build-plan 一个 agent skill,能够将计划(构建计划、技术设计方案、提案、playbook)转化为一个精美的、独立的 HTML 页面:带有编号章节的固定侧边栏、通俗语言的写作规则、内联 SVG 图表、可选的语言切换功能(支持任意两种或多种语言;示例中使用 EN/中文),以及你的代码库 logo。 ## 安装 ``` npx skills add yulonghe97/build-plan --skill build-plan -g ``` 去掉 `-g` 即可在代码库本地进行安装。 ## 功能介绍 ![skill 包含的内容](https://static.pigsec.cn/wp-content/uploads/repos/cas/60/6074b790eed8594d401d03df446280ca1952006e64f2e59c9fad2186f5bba3e2.svg) 按优先级排序: 1. **强制使用通俗语言。** 标题包含核心要点(“六个步骤,仅需两次模型调用”,而不是“工作流概述”),使用短段落,多用数字少用形容词,不使用行话,不使用破折号。每种语言都遵循相同的规则。 2. **图表胜于文字。** 任何具有结构性的内容(架构、流程、循环、时间线)都会变成一个内联的 SVG 图表,并在下方附上带编号的说明,使用框架自身的基础元素绘制。 3. **生成一个独立的 `index.html`**,采用简约的白/墨/橙风格:带有编号章节的固定侧边栏、当前章节追踪、表格、标注框、移动端布局。无需构建步骤,可在任何地方打开。 4. **默认为单一语言;按需增加。** 额外语言(任意语言,且可多于两种;EN/中文仅作示例)会添加一个语言切换开关,并通过内置校验器确保字典 key 的一致性。 5. **记住你的设置。** 代码库 logo 发现和语言选择会被保存(agent memory 以及 `.context/build-plan-prefs.json`),因此第二个页面绝不会重复询问第一个页面已经了解的内容。 ## 示例 输入一个 prompt,输出一个页面。下方的截图来自测试套件 (`evals/evals.json`),由该 skill 根据描述 webhook 中继服务的一个三句话 prompt 生成: ![计划页面示例](https://static.pigsec.cn/wp-content/uploads/repos/cas/82/82e014dd96ef56addaf981b7b7a891aec19e5f6907bd16c3c797efe00ade252b.png) 多语言模式(可选,选择一次后会自动记忆)提供了一个带有 key 一致性校验的语言切换开关;此示例恰好使用了 EN/中文: ![多语言示例](https://static.pigsec.cn/wp-content/uploads/repos/cas/c6/c666257b202eae7f36f0f8b99773a5712e163094ddc9c60101b58a768656f4ff.png) 这两个页面都在 [`examples/`](examples/) 中——它们是独立的,可以直接在本地打开。 ## 布局 ``` SKILL.md the skill assets/technical-page.html canonical page framework (copy, then fill) scripts/validate-page.mjs validates i18n parity, nav order, placeholders, and estimated SVG text overflow (all languages) evals/evals.json test prompts used to iterate on the skill examples/ pages generated by the test suite ```
标签:AI智能体, MITM代理, SOC Prime, 前端页面生成, 后端开发, 多模态安全, 开发工具, 效率工具, 数据可视化, 文档生成, 网络调试, 自动化