ARTICLE DETAIL

资讯详情

深耕网站建设、视觉设计与SEO优化的一线实战洞察。

EmDash 文档反 AI 味编辑指南:从 anti-slop.md 到可执行的去水检查流程

EmDash 文档反 AI 味编辑指南:从 anti-slop.md 到可执行的去水检查流程 EmDash 文档反 AI 味编辑指南从 anti-slop.md 到可执行的去水检查流程【免费下载链接】emdashEmDash is a full-stack TypeScript CMS based on Astro; the spiritual successor to WordPress项目地址: https://gitcode.com/gh_mirrors/emdas/emdash本文基于 EmDash 仓库中的 anti-slop.md 编写。该文档是 writing-emdash-docs 技能集的核心参考用于在文档事实核查完成后逐句审视这句话是在陈述信息还是在表演信息。读完本文你将掌握一套可复用的编辑检查方法识别否定先行揭示、重要性自封、延迟名词、修辞设问、戏剧性节拍等 AI 写作痕迹同时避免因过度修正而引入新的事实错误。这套方法同样适用于你的博客、README、API 参考与迁移指南。反 AI 味编辑在整个文档流程中的位置SKILL.md 将文档生产拆成三步加载上下文读取 AGENTS.md 与风格指南、按文档类型起草、最后运行反 AI 味检查。关键约束是顺序先在事实层面把文档补全再逐句打磨。对于散文密度高的修订作者应在每次改动后用 anti-slop.md 审视每个被改动的段落对于纯事实的小修正则不需要机械地加载整份参考只需应用同样的判断。仓库的 AGENTS.md 明确要求编写、修订或评审文档时加载writing-emdash-docs技能并将其用于公开文档、README、贡献者指南、技术规范、发布说明与变更集。这意味着反 AI 味检查不是可选的润色步骤而是 EmDash 文档贡献流程的一部分。中心测试Stating 还是 Staging反 AI 味检查的第一条也是最重要的一条是问每个句子它是在陈述信息还是在布置信息。陈述式散文把主语、行为和结果直接写在页面上。布置式散文则相反它藏起一个名词、虚构一个对比、给自己的重要性贴标签或者在给出事实前先制造一个节拍。原文档给出的对照是布置式It is not just a schema change. It is the key to a more flexible content model.陈述式Adding the field changes the collection schema and makes the field available to every entry in that collection.第二个问题同样关键这一段是否可以被换成任何 CMS、API 或开源项目如果可以就把泛泛的赞美或建议替换为可验证的 EmDash 具体行为或者直接删除。EmDash 的 docs-style-guide.mdx 用同一思路给出了句子级测试如果删掉这个句子正在完成任务、试图把文档读完的读者会因此受损吗如果不会就删掉。 两处标准一致文档的存在价值是帮助读者完成任务而不是展示作者的文笔。在修改个别措辞之前先通读整篇文档。重要性声明、含糊的过渡句和泛泛的总结往往掩盖着一个矛盾、一个未经支持的论断、一个缺失的前提或流程中的缺口。事实冲突应单独报告并把解决冲突的决定留给原作者而不是在润色时顺手替你定论。识别布置式揭示的七种机制anti-slop.md 列出七种典型的揭示机制每种的处置方式都是同一句话把事实直接说出来。否定先行揭示not just X, but Ythe problem is not X; it is Y或者一个读者从未提出过的稻草人解读。处理方式是直接陈述受支持的行为。只有当你在纠正一个读者很可能持有的错误模型、或区分两个容易被混淆的 API 时才保留对比。重要性自封the real issuewhat mattersthe key takeawaycrucialpivotal。删除排名直接陈述使该事实重要的事实本身。延迟名词与悬念there is one catch、段落结尾的冒号、答案前的here is where it gets interesting。在约束第一次相关时就说出它的名字。修辞设问只为了在下一句回答而提出的问题。把两者合并为一个陈述句除非这个问句是读者真的会用来导航的标题。戏剧性节拍孤立的片段、用于抖包袱的破折号、为了庄重感单独成行的短句。把思想并入所属段落或用正常方式陈述结果。格言式收尾一段可引用的对比或道德说教只是把段落重复了一遍。在最后一个有用的事实或动作处结束。自我打分this is rigorousworth notingthe useful distinctionas the data clearly shows。呈现证据让读者自己评估。这些机制有一个共同点它们让读者为即将到来的信息做心理准备而不是直接给出信息。EmDash 风格指南要求中立、事实性的句子直接陈述事实正是为了消除这一整类噪音。缺失精确性让真实机制显形第二类问题是风格掩盖了实际机制。处理原则是让真实的主体行动起来把行动交给真实的行为者。用The runtime caches the result for the request不用The cache takes care of repeated work.用一个可用的名词替代指向性的thisthatthe formerthe latterone thing。把结构性隐喻和装饰性隐喻替换为具体行为the hingethe seamload-bearingunder the hoodmagicwearing the costume of。用可观察的效果、需求、名称或测量值替代促销性形容词和评判。当serves asboastsfeaturesoffers只增加仪式感而不增加含义时改用is、has、uses。删掉声称重要性的分词尾巴highlightingshowcasingunderscoringensuringfosteringreflecting。如果证据支持该论断就保留它并给它一个完整的句子。注明谁报告或测量了一个论断不用experts saydevelopers agree这类含糊出处。保留仓库支持的、不寻常的具体细节。泛化的重写常常把精确行为抹平成一句可以描述任何产品的话。风格指南对这一点的表述是记录如何用 EmDash 构建而不是 EmDash 是如何构建的实现细节只有在改变读者决策时才进入文档。反 AI 味检查补充了句子层面的对应物——机制、行为者和后果必须精确到可以直接操作的程度。通用 AI 词汇表当作检查提示而非禁用清单anti-slop.md 给出了一份短语清单要求把它们当作强提示来审视所在句子尤其是当它们成群出现时delve、dive deep、embark、navigate the complexitiestapestry、landscape、realm、ecosystem当它们被用作比喻时robust、seamless、scalable、cutting-edge、game-changingunlock、harness、elevate、leverage 或 utilize当use就足够准确时crucial、pivotal、myriad、plethora、transformativein todays ...、at the end of the day、it is important to note、that saidseam、fold、load-bearing、belt-and-suspendersfootgun、rabbit hole、yak shaving、sane defaults、just works处理方式只有两条把短语替换为具体行为如果句子没有具体行为就删除它。SKILL.md 特别强调把模式清单当作判断的提示而不是词汇禁令。 一个被标记的短语可能是正当的一个陌生的短语也可能执行同样的坏模式。EmDash 风格指南给出的示例很能说明问题——Plugins run in an isolated runtime and can only reach the APIs they declare. 是通过陈述事实而 Plugins live in a cosy little sandbox where nothing bad can ever happen! 是失败拟人化、轻佻、承诺了未证实的安全性。结构与节奏句子之上还有一层反 AI 味检查不只针对句子还要在句子之上检查文档结构。原文档列出了九个检查点强迫三连列出真实的条目数量不要为了凑成三个而增删。碎片化短句当三个或更多短并行片段实为伪装的列表时合并成散文。句式单一根据思想变化句长不要机械地长短交替。过度均衡的章节按读者需求和风险分配篇幅而不是按对称性。假范围只有真正的端点才用from X to Y否则直接列出主题。含糊标题把Why it mattersWhat this really means这类评判形标题换成直接命名章节内容的短标签。风格指南要求标题在目录中单独可读且使用 sentence case、不带句尾标点——这两份文档在这里完全一致。层级破坏删除重复的页面标题、跳过的标题级别、紧跟子标题的标题以及用来替代结构的装饰性分隔线。行内标题列表避免只是重复每个要点开头几个字的加粗标签只有当它们是真实术语、选项名或索引时才保留标签。列表成瘾与表格成瘾连贯的论证用散文真正平行的条目或步骤才用列表有意义的行列关系才用表格不要用表格装饰短列表或把不相干的思想塞进等大的格子里。破折号过度使用破折号用于有用的行内补充不用于拖延重点。反复出现的抖包袱式破折号会让技术散文显得是制造出来的。优雅变体同一事物重复使用同一技术术语。同义词可能暗示存在第二个概念。聊天机器人与 diff 残留删掉生成过程的痕迹第三类需要删除的是属于生成过程而非文档本身的文字Great questionCertainlyI hope this helps或邀请读者继续提问。In this guide, we will explorelets dive infirst, some background 这类清嗓子的开场。赞美、附和、表演式谦逊或关于写作任务有多难的评论。常青文档中的Nownewpreviouslywas addedwas updatedreplaces the old approach。版本差异应放在发布说明或升级指南中。EmDash 风格指南专门有 Evergreen, not changelog 一节面向用户的页面只描述 EmDash 现在如何工作读者脑海中没有任何旧版本。迁移指南的固定结构才是承载前后行为差异的唯一位置。只复述大纲、没有结果、动作或约束的泛泛结论。占位符指令、提示片段、模型引用标记、搜索结果链接、跟踪参数以及其他生成产物。文档即代码的理念贯穿 EmDash文档站点本身是一个 Astro 项目文档变更走与代码相同的 PR 与评审流程。这意味着生成残留一旦进入正文就会成为必须由人类评审修复的线上缺陷。另外要逐一验证每个引用和外部链接确认它存在、能解析到声称的来源、并支持相邻的陈述。一次漂亮的改写并不能修复一个虚构的 DOI、无关的来源或未经支持的归属。这正是 check-reference-inventories.mjs 在仓库层面的做法——它解析packages/core/src/schema/types.ts中的FieldType联合类型、packages/core/src/plugins/types.ts中的PluginHooks接口、EmDashConfig配置项与 CLI 命令树再与 field-types.mdx、hooks.mdx、configuration.mdx、cli.mdx 文档中的章节标题和选项逐一比对任何缺失或多余都会抛错。文档与源码之间的每一条对应关系都必须是可机械验证的。避免过度修正不把文档改平、改假反 AI 味编辑最大的风险是把自然的散文也一并清除。原文档专门列出过度修正的禁令保留必要的限定语、不确定性、范围和警告。保留定义了真实边界或防止常见错误的否定句。当列表、表格、标题和加粗术语能改善查找或导航时保留它们。保留署名文章中有意的个人语气。EmDash 公开文档使用风格指南定义的中立语气。保留周围页面既有的语域除非该语域与 EmDash 风格指南冲突。即使每个句子单独都合格一段突然变得华丽或促销的段落仍然是质量问题。绝不为了增加具体性而编造事实、来源、引文、测量、日期、观点或轶事。绝不为了听起来像人而用随意的同义词替换精确的技术术语。不要以规避 AI 检测器为目标。目标是让读者准确地完成任务。这最后一条直接呼应了本文开头EmDash 文档的存在理由是帮助某人完成某事然后回到自己的项目。写作对象是疲惫的、赶时间的、用第二语言阅读的、或刚接触这套技术栈的读者。最终检查清单六问定稿原文档以六个问题收尾作为任何一版润色的验收标准删掉这个句子读者会损失信息或必要的过渡吗是否有句子在告诉读者哪个句子重要标题单独出现在目录中时能说明它的内容吗最后一段是增加了结果或动作还是只复述了页面主题这次编辑是否改变了论断、删除了限定语或增加了无依据的具体性每个示例是否使用了真实的 EmDash 名称与行为其中第 6 条是最容易被 AI 写作流程打破的编造 API 名称、不存在的配置项或虚构的默认值是反 AI 味检查的最终防线。与之配套SKILL.md 给出的评审清单要求通读成品、核对标题与内容一致、确认每一步都从上一步的状态出发、并对照仓库检查链接、文件名、命令与声明的结果。在 EmDash 仓库中落地这套流程反 AI 味检查的完整落点可以概括为一条操作链起草时先确定读者读完能做什么再按文档类型教程、任务指南、概念、参考、排障、迁移指南选择结构事实核查阶段用源码、类型、测试和命令帮助逐条验证技术论断最后按本文的句子级检查过一遍散文用 SKILL.md 的四个问题自问——它是在陈述还是在布置揭示它是否精确命名了行为者、行为与后果它是否增加了读者需要的信息它是否保留了来源的意义、不确定性与范围验证环节在 SKILL.md 中有具体命令pnpm lint:quick pnpm --dir docs build git diff --check公开文档、文档配置或该构建共享的内容变更需要运行 docs 构建仅因另一个 Markdown 文件变更而运行构建是没有必要的。编辑技能文件时需要校验 frontmatter 和相对链接。如果校验失败是因为声明输出缺失先运行根构建再重试剩余的失败应视为本次改动引入的问题而不是改动前的既有基线。这套流程的价值在于它把去 AI 味从一个模糊的审美偏好变成了一套可逐句执行的检查清单并且每一条都以读者能否完成任务作为最终裁判。【免费下载链接】emdashEmDash is a full-stack TypeScript CMS based on Astro; the spiritual successor to WordPress项目地址: https://gitcode.com/gh_mirrors/emdas/emdash创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表