agentleFS
liweijie0812liweijie0812/tdesign-skills/skills/tdesign-docs/SKILL.md

tdesign-docs

Skill4 starsChanged 5 months agoMITView on GitHub

当用户询问 TDesign 文档入口、资料在哪里、当前技术栈有哪些组件可用、组件覆盖矩阵、上游来源链接,或需要决定先读哪个目录时使用。只做资料检索、覆盖确认和来源路由;不回答组件怎么用、示例代码、props/事件/插槽或页面组合。

The file

Files
SKILL.md

TDesign 文档与资料入口

本 skill 用于回答"资料在哪里、当前栈有什么、应该先读什么"。它不替代组件选型、场景搭配或具体 API 实现。如果同目录存在 ../tdesign-skills/references/constraints.md,可参考它获取更详细的跨 skill 约束。

使用协议

  1. 必须通过 load_skill 加载本 skill,不要绕过 skill 系统直接 grep、find 或 read references/ 下的内部文件。load_skill 返回的 SKILL.md 包含查阅顺序和约束上下文,直接读文件会丢失这些关键指导。
  2. 严格按下方「查阅顺序」执行,不跳步、不凭经验猜路径。
  3. 需要交接到其他 skill 时,对目标 skill 再次 load_skill,不要直接读目标 skill 的 references/ 文件。
  4. references/ 下的文件只在 SKILL.md 指引下按需读取,它们是 skill 的内部资料,不是独立文档。

如果用户已经在问“某组件怎么用”“给个代码示例”“props/事件/插槽怎么写”,本 skill 只负责指出该去哪个技术栈 API 目录,不直接凭 docs 总览回答实现细节。

查阅顺序

  1. 技术栈、组件覆盖和本地示例模板标记:查 references/meta/stack-matrix.json(全局概览),以及按端分文件 stack-matrix-web.json、stack-matrix-mobile.json、stack-matrix-miniprogram.json(各栈组件列表与 coverage.hasExample;组件是否可用也可用 get-component-list 确认)。
  2. 上游来源链接和同步信息:查 references/meta/source-links.md。
  3. API 资料入口:references/api/README.md 是组件 API 查询约定(经 tdesign-mcp-server),references/api/index.md 说明 framework 映射与查询方式,references/api/shared/ 是跨端共享语义与端差异入口;先读 README 再按需进 index。
  4. 选型资料入口:已安装 tdesign-usage-guide 时查 ../tdesign-usage-guide/references/decisions/README.md;未安装时只说明应补装该 skill,不在 docs 内替代选型判断。
  5. 场景卡入口:已安装 tdesign-composition 时查 ../tdesign-composition/references/scenarios/README.md;未安装时只说明应补装该 skill,不在 docs 内替代页面组合判断。
  6. Web 视觉一致性、间距、配色、排版、圆角、阴影和状态规则:转到 tdesign-design-spec 的 references/design/visual-consistency-web.md。未安装时提示补装 tdesign-design-spec。
  7. 色彩、布局、Token、中后台框架等设计资料:转到 tdesign-design-spec 的 references/design/ 目录(docs 只负责指路,不展开设计细则)。未安装时提示补装 tdesign-design-spec。

快速查询

可用 scripts/query-matrix.mjs 在终端直接查询矩阵数据:

node skills/tdesign-docs/scripts/query-matrix.mjs --list-stacks          # 列出所有技术栈
node skills/tdesign-docs/scripts/query-matrix.mjs --component Button     # 查某组件在各端覆盖
node skills/tdesign-docs/scripts/query-matrix.mjs --stack react --component Button  # 单栈查组件
node skills/tdesign-docs/scripts/query-matrix.mjs --stack vue-next --components      # 列出某栈全部组件
node skills/tdesign-docs/scripts/query-matrix.mjs --stack miniprogram --missing      # 查看缺失组件
node skills/tdesign-docs/scripts/query-matrix.mjs --known-diff dialog    # 查看已知写法差异
node skills/tdesign-docs/scripts/query-matrix.mjs --group web --json     # 按端查询(JSON 输出)

边界

  • 只回答资料在哪里、当前栈是否覆盖某组件、应先读哪个目录。
  • 回答"当前栈有没有某组件":用 references/meta/stack-matrix.json(全局覆盖)和对应端的 stack-matrix-<端>.json。
  • 回答"该选什么组件、为什么":转到 tdesign-usage-guide。
  • 回答"页面通常怎么搭":转到 tdesign-composition。
  • 回答"某个 props、事件、插槽怎么写" 或 "某组件怎么用/给示例":转到对应技术栈 skill。
  • 回答"某能力何时新增或废弃":转到 tdesign-changelog。

约束

  • 组件 API 通过 tdesign-mcp-server 按单组件查询,不整库拉取;不读取仓库里不存在的按技术栈 references/api/ 快照。
  • 不从目录存在推断组件可用性,以 references/meta/stack-matrix.json 或对应端文件为准,因为目录可能包含不完整或过时的资料。
  • 不把 Web only 组件默认用于 Mobile 或 Miniprogram,因为各端组件覆盖范围不同。
  • 选择性安装且目标辅助 skill 不存在时,只回答本 skill 能确认的资料入口和覆盖矩阵;不凭记忆补齐选型、页面组合或设计规范结论。
  • 完整 collection 模式下,详细职责表、跨栈隔离细则和强制约束可参考 ../tdesign-skills/references/constraints.md;未安装时按本文件内联规则执行。

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.