Neplich/dev-agent-skills / agents/docs/skills/manual-gen
manual-gen
Verified依据真实运行界面和代码编写图文操作手册,覆盖用户任务、步骤、结果与恢复方式。
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 849 B |
| _internal/INSTRUCTIONS.md | markdown | 2.5 KB |
_internal/INSTRUCTIONS.md
View on GitHub# 手册编写与验证
## 覆盖与结构
读取当前页面、路由、权限、测试和运行界面。局部更新聚焦指定任务;完整手册盘点相关角色、入口、菜单操作、对话框和结果,确认每项独立用户任务在页面中有明确归属。
按平台、业务场景和独立任务组织目录。索引说明范围与导航,任务页写出适用角色、前置条件、编号步骤、可见界面、截图、预期结果和异常处理。多个连续动作服务同一目标时可以写在同一页。结构整理连同路径引用和导航一起完成。
复杂手册可用表格核对“角色、入口、任务、预期结果、页面、界面与代码证据、截图”。按批次完成全部已授权范围,并用该表核对覆盖。
## 运行界面与截图
使用现有仓库 harness、浏览器工具或适用的自动化工具,按当前环境可用能力选择。先核对环境与登录角色,使用测试数据完成用户已经授权的操作。
为每批截图设定一致的桌面窗口、缩放、主题和导航状态,读取实际内容视口并核对布局。窗口目标可采用 1920×1080,截图保留真实内容尺寸与自然宽高比。浏览器外框与页面内容视口分别记录;实际布局来自运行环境读数。
截取与当前步骤相关的产品区域,在界面稳定后采集。步骤需要打开的菜单或对话框保留在图中。使用脱敏测试数据;秘密、个人信息和环境标识通过安全占位或遮盖处理。截图与正文保持同一产品、环境和操作事实。
## 页面与资源
沿用宿主手册模板。VitePress 站点页面使用 [页面字段](../../docs-agent/_internal/_shared/frontmatter-contract.md),`doc_type: manual`,`related_code` 指向真实路由或组件。根据实际核对情况记录版本锚或 `unverified`。
截图放在引用页同目录,名称如 `step-1-open-settings.png`,以 `./` 相对路径引用。内置 `prepare-site.mjs` 的 `referencedAssets()` 会处理直接引用资源。更新图片时同步相关步骤和图注。涉及索引、导航和 change-map 时一并维护。
## 验证
执行宿主文档检查并渲染修改页面,核对图片可见、比例正确、图注与步骤对应、导航可达、任务可复现。public/internal 变体按实际影响检查。完整手册还要将交付页面与已发现用户任务逐项核对。
报告最终入口与验证结果,准确说明缺少的访问、界面或执行证据。文档更新与发布动作分别按用户授权范围执行。
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |