admin
5afeb6b78a
一、④段整套同步（用户选候选 A）
- 新增 `references/stage-proto-doc/assets/产品文档模板.html`（16 KB／247 行，从备份拷、转 LF）。
- ④段 SKILL.md 换成备份 15:28 那版，并按模板口径改齐：
· 「产品文档框架」从「四块＋一附录」改成**六节** —— 页面结构／功能清单／使用场景／操作流程／
跨页与界面状态／待确认与偏离；与模板同构，⛔ 不从空白页重写结构。
· 编号从 R/S/F 改成 **P 页面／S 场景／F 功能／J 二级功能**，各自唯一、按展示顺序通排。
· 保留旧版有价值的要求：每项功能补齐 做什么／入口在哪／输入边界／异常与恢复；重点功能三处标红；
横向流程图每步写清页面／功能／操作／完成判据。
· 完成标准「七节」→「六节」，自查清单同步换掉「需求」那批条目，补模板与配图两条。
· 路径 `designs/<项目>/` → `docs/pm/<项目>/ui/`（2 处）。
· 补回本机那条「每份产出文档开头都要有一张图」的引用（指向主 skill，段内不复述）。
- 主 skill 同步：四段结构表④行、④段沿革、画图小节（④段画页面结构图 ＋ 用户路径）。
二、open-design 移到技能根（用户选候选 A）
- `git mv product-planning/references/stage-delivery/assets/open-design → open-design/`（4178 文件）。
- `.gitignore` 白名单加 `!/open-design/` —— 否则移出去就不再纳入版本控制。
- 引用改 11 处：路径形态 `assets/open-design/...` → `<技能根>/open-design/...`；
「随段携带的自带件」改称「同根技能」；「路径怎么找」那条改成自带件（段内相对路径）与
同根技能（`<技能根>/<技能名>/`）两类分开写。
- open-design 自己的 ATTRIBUTION.md 两处同步（它现在与 oil-ui-pro 同层）。
- 副作用（有益）：命名闸门读数由 2063 降到 225 —— 此前它把 open-design 里 919 个第三方 md
当成规则一起扫了；现在只扫本包 23 个 md。已确认④段的 H1 与 4a/4b/4c 子步仍在检查范围内。
三、验收
- check_naming.py --ws E:/ProgramData/AIProject/contentm_agent ＝ 通过 225 / 失败 0 / 提示 27。
- 活文件里 `assets/open-design` 残留 0；工作区 CRLF 文件 0。
81 lines
2.9 KiB
Markdown
81 lines
2.9 KiB
Markdown
---
|
||
name: docs-page
|
||
description: |
|
||
A documentation page — inline-start nav, scrollable article body,
|
||
inline-end table of contents. Use when the brief mentions "docs",
|
||
"documentation", "guide", "API reference", or "tutorial".
|
||
triggers:
|
||
- "docs"
|
||
- "documentation"
|
||
- "guide"
|
||
- "tutorial"
|
||
- "api reference"
|
||
- "文档"
|
||
od:
|
||
mode: prototype
|
||
platform: desktop
|
||
scenario: engineering
|
||
preview:
|
||
type: html
|
||
entry: index.html
|
||
design_system:
|
||
requires: true
|
||
sections: [color, typography, layout, components]
|
||
craft:
|
||
requires: [typography, typography-hierarchy, typography-hierarchy-editorial, rtl-and-bidi]
|
||
---
|
||
|
||
# Docs Page Skill
|
||
|
||
Produce a single, three-column documentation page in one HTML file.
|
||
|
||
## Workflow
|
||
|
||
1. **Read the active DESIGN.md** (injected above). Use the body type token for
|
||
prose; the mono token for code; respect line-height and max-width rules.
|
||
2. **Pick a topic** from the brief — the page should look like real docs, not
|
||
a generic wireframe. Concrete API names, command examples, plausible
|
||
parameters.
|
||
3. **Lay out** three regions, expressed on the inline axis so the
|
||
layout flips correctly under `dir="rtl"`:
|
||
- **Inline-start nav** (240–280px, sticky): grouped link list, current
|
||
page bolded with an `inline-start`-edge accent stripe. 3–5 groups
|
||
of 4–8 links.
|
||
- **Article body** (max-width ~720px, centered in the middle column):
|
||
H1, lede paragraph, H2 sections, code blocks, callout boxes (note /
|
||
warning), inline links, lists.
|
||
- **Inline-end TOC** (200–240px, sticky): "On this page" with the
|
||
H2/H3 anchors, current section highlighted as the user scrolls.
|
||
4. **Write** a single HTML document:
|
||
- `<!doctype html>` through `</html>`, all CSS inline.
|
||
- CSS Grid for the three columns; sticky positioning for the rails.
|
||
- Code blocks: monospace token, soft surface fill, copy-button affordance
|
||
(visual only — no JS needed).
|
||
- Anchor IDs on every H2/H3 so the TOC links work.
|
||
- `data-od-id` on the nav, article, and TOC.
|
||
5. **Prose**: write at least 350 words of believable docs. Include at least
|
||
one shell command, one code snippet (5–15 lines), one callout, one table.
|
||
6. **Self-check**:
|
||
- Body text wraps at the DS line-length sweet spot (60–75 chars).
|
||
- Code uses the DS mono token, not generic `monospace`.
|
||
- Accent is restrained — used for active nav item, links, one callout
|
||
border. Not on body text.
|
||
- Page is readable at 1280w and collapses gracefully below 900w (TOC drops
|
||
out, nav becomes a top drawer).
|
||
- Use logical CSS (`margin-inline-start`, `border-inline-start`,
|
||
`inset-inline-end`, `text-align: start`) on the rails and accent
|
||
stripe so the layout flips correctly under `dir="rtl"`.
|
||
|
||
## Output contract
|
||
|
||
Emit between `<artifact>` tags:
|
||
|
||
```
|
||
<artifact identifier="docs-slug" type="text/html" title="Docs — Page Title">
|
||
<!doctype html>
|
||
<html>...</html>
|
||
</artifact>
|
||
```
|
||
|
||
One sentence before the artifact, nothing after.
|