写作与内容

e2e 文档写作规范技能

为 e2e 文档站编写、精简和重构指南页面时,自动套用一套以读者浏览习惯为中心的写作与瘦身规范。

54/ 100
谨慎使用

价值存在,但可靠性、证据或控制措施仍有明显缺口。

查看评分依据 ↓
可直接使用于
Codex · Claude Code
Star 数
★ 8.7k
最近更新
1 天前
License
Apache-2.0
technical-writingdocumentationmdxmintlify
+4style-guideeditorial-standardscontent-editingasd-ste100

这个 Skill 能做什么,适合哪些场景?

authoring-docs 是 e2e 仓库中专门针对其文档站(docs/**/*.mdx,非 reference 目录)的写作技能。它规定了页面骨架、图标规范、Mintlify 折叠组件的选用、以及基于 ASD-STE100 的语气规则。核心要求是每一页在提交前都必须经过'缩短'检查:统计行数与正文字数、删除重复表述、把可选内容折叠。它还提供重写遗留页面的十步流程和提交前的核对清单。

  • 读取并分析 docs/ 下的 MDX 指南页面,统计行数和正文字数,与侧边栏同级页面比较长度
  • 按'删掉读者不行动的内容、合并重复表述、折叠少数读者需要的内容'三类顺序执行精简
  • 按{noun}模板输出页面骨架:lede、Before you start、任务标题、Next 卡片组
  • 依据组件对照表选择 Tabs、CodeGroup、Steps、Accordion、ShowMore、Note、Warning 等折叠方式
  • 校对页面图标:docs/images/icons/ 下的黑色剪影 SVG,检查明暗两种模式
  • 提交前逐项核对清单,并运行 pnpm docs:check 验证
适合
  • 为 e2e 文档站撰写新的集成指南页面,想直接套用 quickstart 和 bug-bash 的成熟页面结构
  • 接手一段历史遗留的冗长 MDX 页面,需要系统性地重写而不是小修小补
  • 某个代码改动(如重命名一个 flag)波及三篇文档,只想对受影响部分做削减、其余列为后续
  • 用户问'这页怎么缩短',想先拿到按行数估算收益的削减方案再动手
  • 需要给页面挑一个合适的 Font Awesome 图标或制作品牌剪影图标
不适合
  • e2e 的 reference 目录页面——技能明确声明参考页保留自己的查找表结构,不适用此规范
  • skills/e2e/ 目录下的内容——技能声明该目录供 agent 顺序阅读,交互组件在其中不渲染
  • 不属于 e2e 仓库的文档项目——规范中的路径约定(docs/images/icons/、docs/docs.)和脚本(pnpm docs:check)都是仓库专用的,直接移植需要改造

如何安装这个 Skill?

使用前请注意
  • 发布者未经验证,身份视为未知;使用前请自行确认仓库来源。
  • 本评估为纯静态源码审查,未执行任何命令或验证脚本,所有评分置信度为低。
  • 技能依赖该仓库内部约定(Mintlify 组件、docs:check、unslop 技能、docs.),在其他环境中直接复用效果未知。
  • 技能引用的范例页面(bug-bash.mdx、quickstart.mdx)内容未在本次证据中,相关声明未交叉核实。
  • 文档站与 npm 生态在海外,中国大陆用户访问依赖资源时可能受限。
开始前你需要
Agent 需要具备
  • Shell / 命令行
  • 本地文件系统
需要预先安装
  • pnpm
  • Mintlify docs toolchain (docs:check, docs:dev scripts)

来源材料未提供该技能的安装命令。README 只说明整个仓库包含 10 个技能,本技能位于 .dev/skills/authoring-docs/SKILL.md,但未给出任何安装/加载命令(如 plugin add 或复制命令),因此具体的安装步骤在此不作臆造。

通用方式:手动安装到 Claude Code(macOS / Linux)
tmp="$(mktemp -d)"
git clone --depth 1 https://github.com/tester-army/e2e.git "$tmp"
mkdir -p ~/.claude/skills
cp -R "$tmp/.dev/skills/authoring-docs" ~/.claude/skills/
rm -rf "$tmp"

根据源仓库地址和 Skill 路径自动生成,只复制这个 Skill 的文件夹。如果上文有作者提供的安装方式,请优先按作者说明操作;想只在当前项目中使用,把 ~/.claude/skills 换成项目里的 .claude/skills。

如何使用这个 Skill?

试试这样说

安装后,把下面任意一句发给 Agent 即可触发:

  • 帮我写一篇新的 e2e 集成指南页面 docs/integrations/xxx.mdx,按照技能规范给出页面骨架
  • docs/ci/cache.mdx 比同级页面长了一倍,帮我运行缩短检查并给出削减计划,标注每项节省的行数
  • 这次 PR 重命名了一个 flag,更新了三篇文档,请只对涉及的章节执行削减,其余列为后续任务
  • 重写 docs/migrate/legacy.mdx 这个遗留页面,保留所有事实,按十步流程执行

该技能通过前置元数据中的描述自动触发:当任务涉及'编写、编辑、重写或缩短文档站指南页面(docs/**/*.mdx,非 docs/reference/)'时启用,元数据标记为 internal。工作流程:先写出目标大纲;对每页运行缩短检查(用 wc -l 统计行数、用 awk 过滤代码围栏后 wc -w 估算正文字数);将削减项分为三类按序执行;当用户问如何缩短时先展示按类别分组、标注行数收益的计划再编辑;最后按提交前清单逐项核对并运行 pnpm docs:check,用 pnpm docs:dev 以速读者视角预览。

这个 Skill 有哪些优点和局限?

优点
  • 规范极其具体可执行:给出了测量命令、组件选择对照表、句长限制和禁用词表,而不是空泛的风格建议
  • 内置防漂移机制:要求每个新增句子对照 src/ 源码核实,削减的事实须在 PR body 中逐条写明理由
  • 明确界定适用范围(非 reference、非 skills/e2e/),并说明与其他技能(unslop)冲突时以本技能为准
  • 包含重写遗留页面的完整十步流程和锚点链接稳定性检查,覆盖真实维护场景
局限
  • 高度绑定 e2e 仓库的文件路径、Mintlify 组件和 pnpm 脚本,用于其他项目需要大量改造
  • 来源未提供任何安装命令或使用统计,无法验证实际触发效果
  • 该仓库处于 1.0 之前的活跃开发期,技能中引用的具体页面(如 bug-bash.mdx)可能随时间变动

这个 Skill 与同类方案有什么区别?

与相关 Skills 并排比较;分数均按同一 FSRS 标准得出。

Skill FS 评分 Star 数 最近更新 License
e2e 文档写作规范技能 本页 54 · 谨慎使用 ★ 8.7k 1 天前 Apache-2.0
卡兹克公众号长文写作 Skill 49 · 谨慎使用 ★ 21k 10 天前 MIT
说人话:中文去 AI 味改写 Skill 65 · 推荐 ★ 2k 11 天前 MIT
No AI Slop 59 · 推荐 ★ 12k 1 个月前 MIT
Beautiful Prose 写作风格规范 50 · 谨慎使用 ★ 57 9 个月前 —

技能正文中提到与 unslop 技能的关系:unslop 适用于每一句话,本技能在其之上增加文档结构和语气规则,两者冲突时在文档页面上以本技能为准。

FollowSkills 如何评估这个 Skill?

FollowSkills 评估 · FSRS-2.0
谨慎使用
54/ 100 五分制 2.7 / 5
1信任安全16 / 25 · 3.2/5

该技能本身仅是文档撰写指南,不执行命令、不请求权限、无外部副作用;仓库层面有清晰的信任模型(SECURITY.md 区分 code-trust 与不可信模型输入、遥测可关闭且字段全披露、无崩溃上报)。扣分点:技能本身未声明数据流向(如要求对照 src/、引用外部文档站),发布者身份未经验证,回滚/确认机制对文档改动依赖 PR 流程而非技能内声明。

2可靠稳定9 / 20 · 2.3/5

指令自洽性高:范围界定清晰(guides vs reference vs skills/e2e)、缩短流程有可复现的度量命令(wc/awk)、提交前清单完整。扣分点:静态审查无法执行任何验证,多个检查(pnpm docs:check、typecheck、unslop)依赖未在证据中展示的脚本;对异常输入(如页面不存在、命令失败)的失败反馈质量无法核实,按锚点不得高于10。

3适用触发8 / 15 · 2.7/5

触发描述精确:明确了适用场景(docs/**/*.mdx 非 reference)、明确排除范围(reference 页、skills/e2e)、给出了范例页面与骨架。扣分点:边界条件部分依赖仓库内部约定(Mintlify 组件、docs. 重定向、unslop 技能),对非该仓库环境适用性未声明;未涉及中文支持或大陆网络可达性——文档站及 npm 依赖均在海外,但技能核心(写作规范)不依赖在线服务,故只小幅扣分。

4规范维护10 / 15 · 3.3/5

结构清晰、渐进披露良好(先原则后流程后清单)、含范例与前后对照。扣分点:技能自身无版本号/变更日志/已知限制章节,维护责任隐含于仓库贡献流程而非技能文件;name/description 与能力一致,license(Apache-2.0)明确。

5有效结果6 / 15 · 2.0/5

目标明确(写/改/缩短文档页),产出为可直接遵循的编辑流程与检查清单,边际价值高于无指导的改写。扣分点:静态审查无法验证实际改写结果质量,效果证据仅为自我声明的流程与范例引用(bug-bash.mdx、quickstart.mdx 未在证据中),按锚点不得高于7。

6证据核验5 / 10 · 2.5/5

关键声明可部分追溯:引用了具体文件路径、度量命令、检查脚本(check-docs-examples.ts、docs:check),CI 工作流(benchmark、agent)与测试套件存在,且 security/telemetry 声明详细。扣分点:技能自身的关键路径(写作效果、缩短流程产出)无可执行的第三方验证证据,引用的范例页面内容未在证据中提供,静态审查上限为5。

1 2 3 4 5 6

点击维度查看打分理由

评估于 2026年10月10日 审查版本 449fa93670ee 评估证据[1][2][3][4][5][6][7][8][9][10]

证据充分度:低 — 主要依赖静态检查、作者材料或有限演示;适合发现线索,不适合做高风险决策。

查看完整评分方法 →

常见问题

这个技能能用于 e2e 仓库之外的文档项目吗?
部分可以。语气规则、缩短检查方法和页面骨架原则是通用的写作方法论,但其中的路径约定(docs/images/icons/、docs/docs.)、Mintlify 组件和 pnpm docs:check 脚本都是 e2e 仓库专用的,直接照搬会失效。
它适用于所有 e2e 文档页面吗?
不。它只覆盖 docs/**/*.mdx 中除 docs/reference/ 之外的指南页面,包括 docs/ci/、docs/integrations/ 和 docs/migrate/。参考页和 skills/e2e/ 目录明确排除在外。
缩短页面时会不会丢信息?
技能对此有明确防护:每一处削减须按'读者不行动的内容/重复表述/少数人需要的内容'分类并说明理由;重写遗留页面时先列出全部事实清单,要求每条事实最终被保留、折叠、链接或在 PR body 中说明删除原因。
它和其他写作类技能有什么关系?
unslop 技能仍然适用于每一句话,本技能在其之上叠加文档结构和语气规范。两者冲突时,在文档页面上本技能优先,但仍须遵守 unslop 的句长和段落限制,且不使用第一人称。

同仓库的其他 Skills

均来自 tester-army/e2e

写作与内容

Unslop 文风去AI味技能

扫描并改写文本中的AI写作痕迹,同时注入真实的人类声音,让输出读起来像人写的。(description 中标注 Must always apply,即应始终生效。)

★ 8.7k FS 49 谨慎使用 1 天前
开发与工程

writing-pr:PR 标题与描述撰写规范

一套让审阅者第一屏就看懂变更形状的 PR 撰写规范:Conventional Commits 标题、证据驱动的正文和必填的本地验证章节。

★ 8.7k FS 58 推荐 1 天前
开发与工程

e2e Verify —— 端到端变更验证技能

用真实 CLI 对测试底座和基准应用跑真实验证,为每一处改动留下可看见的证据,而不是只说"编译通过了"。

★ 8.7k FS 64 推荐 1 天前
开发与工程

Ship a PR(e2e 仓库 PR 交付流程)

把 tester-army/e2e 仓库中已完成的工作,交付成一个人类无需对抗 CI 和机器人评论就能审查的 PR:跑检查、验证、新上下文自审、开 PR,并一路盯到打上 Ready for Human Review 标签。

★ 8.7k FS 59 推荐 1 天前
开发与工程

e2e Playground 验证技能

在声称 playground 改动可用之前,用 e2e 启动、驱动并截图取证验证 apps/testbed 测试应用。

★ 8.7k FS 59 推荐 1 天前
开发与工程

Create Verification Skill(e2e 验证技能生成器)

为你的项目自动生成一个 verify-<app> 验证技能,让任何编码智能体能像真实用户一样启动应用、驱动功能、留存证据并做 bug bash。

★ 8.7k FS 54 谨慎使用 1 天前
开发与工程

babysit — PR 自动值守技能

自动推动一个开放 PR 解决冲突、回复评审机器人、修复 CI,直到全绿并打上"Ready for Human Review"标签,把机器能清的障碍全部清完。

★ 8.7k FS 54 谨慎使用 1 天前
开发与工程

unbox-ai — AI Agent 追踪分析 CLI

在命令行里分析 AI agent 的追踪文件,不用去读几兆字节的原始 JSON,就能查明 agent 为什么慢、为什么贵。

★ 8.7k FS 54 谨慎使用 1 天前
开发与工程

e2e 智能体端到端测试

用自然语言目标驱动浏览器与移动端 UI 测试,混合 agent 步骤与精确定位器断言,并带重放缓存降低模型成本。

★ 8.7k FS 52 谨慎使用 1 天前

相关 Skills