prose-standard

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Prose Standard

文案规范

Write enough to preserve the contract, then remove reasoning transcripts, repetition, and decoration. A contract is an obligation, invariant, precondition, postcondition, or compatibility promise that a caller, callee, implementer, producer, consumer, reader, or maintainer relies on. This skill owns editorial judgment and required prose coverage; follow your repository's documentation standard for placement, budgets, bilingual pairs, and documentation gates, and audit reasoning-transcript leakage — dead session citations, change narration, review choreography, hedges — with its own taxonomy. It is guidance, not a script.
Treat
contract
,
boundary
,
shape
,
surface
,
seam
,
gate
, and
vocabulary
as terms to check before use, not banned words. First ask whether the exact rule, API, field set, type, validation, timing point, component split, or failure states the fact better. Keep a term when it names the exact technical subject, including caller/callee contracts and security or process boundaries.
撰写内容时需保留完整契约,再移除推理记录、重复内容和修饰性表述。Contract指的是调用方、被调用方、实现者、生产者、消费者、阅读者或维护者所依赖的义务、不变量、前置条件、后置条件或兼容性承诺。本Skill拥有编辑判断权和必要文案覆盖范围的决定权;需遵循仓库的文档规范来确定内容位置、篇幅限制、双语配对规则和文档审核关卡,并按照专属分类体系审计推理记录泄露情况——包括无效会话引用、变更说明、审查流程记录、模糊表述等。本规范为指导性内容,而非固定脚本。
contract
boundary
shape
surface
seam
gate
vocabulary
视为使用前需确认的术语,而非禁用词汇。首先要判断具体规则、API、字段集、类型、验证逻辑、时间节点、组件拆分或故障状态是否能更准确地表述事实。当术语恰好指代特定技术主题(包括调用方/被调用方契约、安全或流程边界)时,可保留该术语。

Inputs and exclusions

输入要求与排除范围

Require an explicit
scope
. If it is missing, report the required input and stop; do not infer a repository-wide scope or begin an interview.
Accept
mode: automatic | interactive
; default to
automatic
. Enter interactive mode only when the user explicitly requests questions or calibration.
mode
controls questions, not write authority: review and audit tasks report findings without editing; explicitly requested write, fix, or trim tasks apply clear changes.
Always exclude
vendor/
from discovery, review, and edits, even when the requested scope is the whole repository. Do not follow a symlink into it. Put exclusions after inclusion globs so a later include cannot re-admit it — for example, end ripgrep commands with
--glob '!vendor/**'
and give Git commands an explicit
:(exclude)vendor/**
pathspec. If the requested scope contains only
vendor/
, report that no eligible files remain.
Also exclude frozen archived notes from review and edits. Archived notes are frozen snapshots; inspect an exact target only to understand a historical inbound citation, never to modernize its prose or outbound links.
Treat generated catalogs, snapshots, and fixtures as derivative. Edit the owning source or scenario first, then regenerate the artifact. When a generator extracts a summary from owner prose, make the extracted sentence complete for that surface. Bilingual pairs have no permanent owner: either language may be the authored side for an update, and the counterpart must follow in the same change.
需要明确指定
scope
。如果缺失,请报告所需输入并停止操作;请勿推断仓库级别的范围或开始询问。
支持
mode: automatic | interactive
;默认值为
automatic
。仅当用户明确要求提问或校准才进入交互模式。
mode
仅控制是否提问,不影响编辑权限:审查和审计任务仅报告结果,不进行编辑;明确要求的撰写、修复或精简任务需执行清晰的修改。
始终将
vendor/
目录排除在发现、审查和编辑范围之外,即使请求的范围是整个仓库。请勿跟随符号链接进入该目录。将排除规则放在包含规则之后,避免后续的包含规则重新纳入该目录——例如,在ripgrep命令末尾添加
--glob '!vendor/**'
,在Git命令中使用明确的
:(exclude)vendor/**
路径规范。如果请求的范围仅包含
vendor/
,请报告没有符合条件的文件。
同时将冻结的归档笔记排除在审查和编辑范围之外。归档笔记是冻结的快照;仅在理解历史引用时才查看特定目标,绝不更新其文案或外部链接。
将生成的目录、快照和测试数据视为衍生内容。首先编辑对应的源文件或场景,再重新生成产物。当生成器从源文案中提取摘要时,需确保提取的句子在对应场景下完整通顺。双语配对内容没有固定的主语言:更新时可选择任意一种语言作为编写方,另一种语言必须同步修改。

Preserve the complete proposition

保留完整命题

Before editing, identify every proposition in the passage. Preserve each relevant:
  • actor and action;
  • condition, timing, and ordering;
  • modality such as must, may, or never;
  • negative guarantee and exception;
  • ownership, side effect, failure mode, and consequence.
Remove adjectives, repetition, and narration only when every factual clause survives and the result is clearer. A smaller word count alone is not an improvement.
Keep a complete local contract at the point of use: behavior, failure, ownership, and consequence that a caller or maintainer needs there. Aggressively link to the owning document for architecture, rationale, algorithms, history, or extended examples. One explanation has one home; essential contract facts may repeat locally. Keep non-obvious rationale when omitting it could plausibly cause misuse or an incorrect simplification; otherwise state the consequence and link the rationale home.
编辑前,需识别段落中的所有命题。保留每个相关的:
  • 参与者与操作;
  • 条件、时间点与顺序;
  • 模态词(如必须、可以、绝不);
  • 否定性保证与例外情况;
  • 所有权、副作用、故障模式与后果。
仅当所有事实条款都保留且结果更清晰时,才移除形容词、重复内容和叙述性文字。单纯减少字数不代表优化。
在使用位置保留完整的本地契约:调用方或维护者所需的行为、故障、所有权和后果信息。对于架构、原理、算法、历史或扩展示例,需主动链接到对应的文档。同一说明内容仅保留一处;必要的契约信息可在本地重复。当省略非显而易见的原理可能导致误用或错误简化时,需保留该原理;否则说明后果并链接到原理文档。

Required coverage by location

按位置划分的必要覆盖范围

Comments describe non-obvious contracts or rationale that code cannot express; they do not restate what code already implies. This is not a one-way shortening pass: add or restore prose when code, types, and structure do not communicate a required contract, and do not add a comment when those facts are already obvious locally.
Required coverage spans skill bodies and descriptions, instruction files, READMEs, Agent Notes, JSDoc, internal and module comments, tests, cookbooks, postmortems, configuration comments, prompts and visible strings, and diagnostics. The full per-location list lives in the coverage reference. Preserve searchable mechanism names and meaningful modal, temporal, or negative emphasis; normalize decorative emphasis only.
注释用于描述代码无法表达的非显而易见契约或原理;无需重复代码已隐含的内容。这并非单向精简流程:当代码、类型和结构无法传达必要契约时,需添加或恢复文案;当这些信息在本地已显而易见时,无需添加注释。
必要覆盖范围包括Skill主体与描述、说明文件、README、Agent Notes、JSDoc、内部与模块注释、测试用例、操作手册、事后分析报告、配置注释、提示语与可见字符串、诊断信息。完整的位置列表请查看覆盖范围参考文档。保留可搜索的机制名称和有意义的模态、时间或否定强调;仅统一修饰性强调的格式。

Workflow

工作流程

  1. Confirm the scope, mode, current branch or PR base, and the applicable instruction files. Do not inspect unrelated branches.
  2. Read your repository's documentation standard and the owning code or document before judging a passage. For calibration or unfamiliar cases, read the coverage reference and the distilled examples.
  3. Inspect the requested scope, not only the largest files. Use searches and word counts to find candidates, then judge passages semantically.
  4. Classify each candidate as keep, add, trim, restore, restructure, or defer. Apply clear changes only when the task authorizes edits; do not manufacture edits to satisfy a deletion target.
  5. Update the owner before derivative artifacts. Re-check analogous passages after learning a new rule.
  6. Run your repository's narrow relevant checks, documentation gates,
    git diff --check
    , and behavior tests for visible strings. Verify the final diff contains no
    vendor/
    path and report any accidental vendor match rather than claiming a clean exclusion history.
  7. Report the inspected scope, clear changes, deliberate keeps, deferred cases, and checks actually run.
  1. 确认范围、模式、当前分支或PR基准,以及适用的说明文件。请勿检查无关分支。
  2. 在判断段落之前,阅读仓库的文档规范和对应的代码或文档。对于校准或不熟悉的情况,请查看覆盖范围参考文档精简示例
  3. 检查请求的范围,而非仅关注最大的文件。使用搜索和字数统计找到候选内容,再从语义上判断段落。
  4. 将每个候选内容分类为保留、添加、精简、恢复、重构或延迟处理。仅在任务授权编辑时执行清晰的修改;请勿为了满足删除目标而刻意制造修改。
  5. 在更新衍生产物之前,先更新源文件。学习新规则后,重新检查类似段落。
  6. 运行仓库中相关的窄范围检查、文档审核关卡、
    git diff --check
    ,以及针对可见字符串的行为测试。验证最终差异中不包含
    vendor/
    路径,若意外匹配到该目录需如实报告,而非声称排除历史干净。
  7. 报告检查的范围、清晰的修改内容、刻意保留的部分、延迟处理的情况,以及实际运行的检查项。

Borderline decisions

边界决策

A case is borderline only when at least two versions satisfy the complete-proposition rule but trade accepted principles, and this skill does not already resolve the tradeoff. A rewrite with one proposition-preserving answer is not borderline.
In automatic mode, apply clear edits when authorized and report genuine borderline cases without asking questions. Do not weaken a proposition to make progress.
In interactive mode, group analogous passages under the governing principle. Present two or three viable versions, recommend one, and state the factual or structural difference. Do not offer inferior distractors. Use the user's requested channel; when calibrating a change through inline comments, place the recommended provisional version in the diff and attach the alternatives to that exact line.
After the user decides, distill the principle and versions into the examples, without review history or reviewer narration, and apply the learned rule to every analogous passage in scope.
只有当至少两个版本符合完整命题规则,但在公认原则上存在取舍,且本Skill未明确解决该取舍时,才属于边界情况。仅有一种符合命题保留要求的重写版本不属于边界情况。
在自动模式下,若授权编辑则执行清晰的修改,并如实报告真实的边界情况,无需提问。请勿为了推进工作而弱化命题。
在交互模式下,将类似段落归为同一原则下。提供两到三个可行版本,推荐其中一个,并说明事实或结构上的差异。请勿提供劣质的干扰选项。使用用户指定的沟通渠道;当通过内联注释校准修改时,将推荐的临时版本放在差异中,并在对应行附上其他备选版本。
用户做出决策后,将原则和版本提炼到示例文档中,无需包含审查历史或审查者叙述,并将学到的规则应用到范围内所有类似段落。