规划师角色切换后的首份交付:把规划做成可交接工件,而非聊天里的建议。 ROADMAP.md 的形态 - 每个任务包含:目标 / 依据 / 依赖 / 精确路径 / 步骤 / 验收命令 / 预期输出 / 失败判据。执行模型照做即可,不需要再问 - 附「交接约定」6 条(零依赖不可破、build-site.ps1 必须 ASCII-only、改结构要改 模板、改样式要改内嵌层、验收以实测为准、单次改动跑八次回归) - 附「验收总纲」5 条(给完整输出、跑八次回归、CHANGELOG 条目、ROADMAP 标记、 新问题写成新任务包不顺手修) 基线全部实测(非估计) - 资产:79 组件 / 395 端文件 / 79 契约 / 358 usageHints / 139 unknowns / 101 doNotInvent / 75 令牌 / 330 字典 / 961 断言 - 回归 100%(八次连跑一致)/ 契约保真 93.9% / 令牌语义 0 错配 / i18n 0 残留 - 性能:文档站 1247KB,其中 data.js 1058KB(85%) - 八项缺口(G1-G8)每项附实测证据 关键诊断(在规划里就完成,避免执行模型走弯路) - data.json 体积实测拆解:sources 字段 888KB = 89.6%。拆出后 data.js 991KB → ~110KB(−89%)。规划里的推测值已被实测替换 阶段划分与决策依据 - S1 可交付(LICENSE/npm/CI/data.js)→ S2 可信(暗色/跨端/行为断言)→ S3 完整(RTL/FAQ)→ S4 生态(Figma/模板/发布) - 顺序依据:S1 是「能不能用」,S2 是「能不能信」,S3 是「够不够全」, S4 是「好不好用」。颠倒会做出没人敢用的产品 顺带执行 P1(验证规划可落地) - LICENSE:MIT 全文,README 新增许可证段与路线图链接,版本号校正为 v1.4.1 - 验收输出:LICENSE OK / README OK - ROADMAP 对应任务包下追加完成标记(验证闭环机制可用) 回归:100%(961 断言 / 0 失败 / 79 页全通过)
3.4 KiB
3.4 KiB
Aurora Admin Design System
理性、高效、克制的 B 端中后台设计系统:79 个组件 × 5 端实现(H5 / React / Vue 2 / Vue 3 / CSS),品牌主色 #2F54EB,全部色值取自 au-* CSS 变量令牌,零运行时依赖。
在线入口
- 组件文档站:
site/index.html(GitHub Pages 部署后为仓库首页自动跳转) - For Agents / llms.txt:
site/llms.txt·site/data.json
目录结构
├─ index.html # Pages 入口(重定向到 site/)
├─ sitemap.xml # 站点地图(构建生成,部署后回填正式域名)
├─ site/ # 文档站(纯静态,无构建依赖)
│ ├─ index.html / app.js / style.css / data.js / data.json
│ ├─ components/<slug>.html # 每组件静态薄壳(SEO 可爬入口,构建生成)
│ ├─ scenario/user-management.html # 场景示范页(用户管理列表页)
│ └─ llms.txt
├─ frameworks/ # 79 组件 × 5 端实现源码(只读引用)
├─ tests/ # 79 个组件测试页 + 回归报告 report.json
├─ tools/run-regression.mjs # Playwright 回归 runner(CI 用)
└─ .design_library/aurora-admin/
├─ components/index.json # 组件 ↔ 规格 ↔ 实现权威映射
├─ components/<slug>.json # 设计契约(21 个:6 核心 + 15 输入类第一批)
├─ colors_and_type.css # 设计令牌(au-* + legacy 双命名)
└─ components.css # 聚合组件样式
快速使用
<link rel="stylesheet" href=".design_library/aurora-admin/colors_and_type.css">
<link rel="stylesheet" href=".design_library/aurora-admin/components.css">
按端取用组件源码:frameworks/<Prefix>.{html,css,jsx,vue2.vue,vue3.vue}。
本地开发
node site/dev-server.js # http://127.0.0.1:3311/site/
powershell -File build-site.ps1 # 重建 data.js / 薄壳 / sitemap(重建后浏览器 Ctrl+F5)
powershell -File run-tests.ps1 # 重新生成 79 个测试页
node tools/run-regression.mjs # headless 回归(需 npm i playwright)
部署(GitHub Pages)
- GitHub 新建仓库(Public)。
git remote add origin git@github.com:<account>/aurora-admin.git && git push -u origin main。- 仓库 Settings → Pages → Source 选 GitHub Actions;推送后
.github/workflows/deploy-pages.yml自动部署整仓。 - 回填正式域名:
build-site.ps1中$SiteUrlBase改为https://<account>.github.io/aurora-admin/,重跑构建后推送。
设计契约与 Agent 消费
- 组件契约(变体维度 / 使用要点 / 不发明 / 未明示):
.design_library/aurora-admin/components/*.json - 文档站
#/agents页汇总全部机器可读资源与使用规则 - 生成 UI 时:色值只取令牌,变体不超出契约
dims,unknowns项先澄清再生成
版本
见 CHANGELOG.md。当前 v1.4.1。
路线图
后续规划(可交付性、可信度、完整度、生态四阶段,含逐任务验收标准)见 ROADMAP.md。
许可证
MIT © 2026 Aurora Admin
可自由用于商业项目、修改、再分发,仅需保留版权声明。如需变更许可证(例如 Apache-2.0 或 MPL-2.0),请参考 ROADMAP.md 的 S1-P1 任务包。