documenting-with-sources

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Documenting with Sources

带来源引用的文档撰写规范

Common conventions for writing Markdown documents that pull from outside sources. Apply to any deliverable that surfaces facts taken from elsewhere — survey reports, paper explainers, and similar.
撰写引用外部来源的Markdown文档的通用规范。适用于任何呈现外部事实的交付物——调查报告、论文解析等类似文档。

Cite every factual claim

为每个事实性声明添加引用

Every factual claim in the deliverable must carry a citation. A claim with no citation cannot be verified, and is worthless as a documented finding. If a claim cannot be tied to a source, mark it explicitly (e.g. "citation not confirmed"). Do not slip uncited claims in silently.
交付物中的每个事实性声明都必须附带引用。没有引用的声明无法被验证,作为记录的研究结果毫无价值。如果某个声明无法关联到来源,请明确标记(例如“引用未确认”)。切勿悄悄加入无引用的声明。

Reference format

引用格式

  • In-text references take the shape
    [label (YYYY/MM), location]
    . How to fill the
    label
    slot (publication name, author short-form, position-only for the paper under review, etc.) is decided by the calling skill.
  • Do not use bare numeric references such as
    [1]
    or
    [2]
    . Numbers alone force the reader to bounce between text and source list; readability drops.
  • For the formatting of quotation blocks themselves (code-block fencing, original-and-translation pairing, where to place the source reference, anti-patterns), follow the
    writing-quotation
    skill. Read
    writing-quotation
    before drafting.
  • 文内引用采用
    [label (YYYY/MM), location]
    的格式。
    label
    字段的填写方式(出版物名称、作者简称、仅针对待评审论文的位置信息等)由调用的skill决定。
  • 请勿使用
    [1]
    [2]
    这类纯数字引用。纯数字会迫使读者在正文和来源列表之间来回切换,降低可读性。
  • 关于引用块本身的格式(代码块围栏、原文与译文配对、来源引用的放置位置、反模式等),请遵循
    writing-quotation
    skill。开始撰写前请先阅读
    writing-quotation

Quotation vs prose

引用内容与原创内容的区分

  • Keep quotations and prose (the writer's own summary or interpretation) visually and structurally separate. Even when not quoting, write in a way that prevents the source's claim and the writer's interpretation from blending.
  • When quoting a source written in a language other than the writer's working language, place the translation alongside the original inside the same code block (see
    writing-quotation
    ).
  • 在视觉和结构上区分引用内容与原创内容(作者自己的总结或解读)。即使没有直接引用,写作时也要避免将来源的声明与作者的解读混为一谈。
  • 当引用非工作语言撰写的来源时,请将译文与原文放在同一个代码块内(参见
    writing-quotation
    )。

No fabricated associations or interpretations

禁止编造关联或解读

Do not write interpretations, speculation, or associations that the source itself does not contain.
  • Do not invent connections such as "this relates to X", "this could be applied to Y", or "this suggests Z" when the source does not say so.
  • Do not import context from the surrounding conversation or the calling project into the body of the document. Descriptions of a source must stay within the source's own content.
  • Good: "Main criticism: even with flipped labels, accuracy does not always drop, and the text-gradient is mathematically distinct from classical gradient descent" (states what the source actually says).
  • Bad: "Relation to AI writing improvement: feedback-based improvement is mathematically different from gradient descent..." (the source does not say this; the connection is fabricated from conversation context).
请勿撰写来源本身未包含的解读、推测或关联内容。
  • 当来源未提及相关内容时,请勿编造诸如“这与X相关”“这可应用于Y”或“这表明Z”之类的关联。
  • 请勿将对话上下文或调用项目的背景信息引入文档正文。对来源的描述必须严格限于来源自身的内容。
  • 正确示例:“主要批评点:即使翻转标签,准确率也并非总是下降,且文本梯度在数学上与经典梯度下降不同”(陈述来源实际表达的内容)。
  • 错误示例:“与AI写作改进的关联:基于反馈的改进在数学上与梯度下降不同……”(来源未提及此内容,该关联是从对话上下文编造而来)。

Source-list format

来源列表格式

The source list at the end of the document uses this format:
[label, YYYY/MM] Author. "Title." Publication. URL
Do not use the
- [n]
list format.
文档末尾的来源列表采用以下格式:
[label, YYYY/MM] Author. "Title." Publication. URL
请勿使用
- [n]
的列表格式。