跳到正文

引用与参考资料

区分原话、技术依据和补充阅读,并在句中的关键词上标明来源。

明确引用承担的作用

需要核对要求、默认值或版本变更时,优先指向该版本的项目文档、源码或发布记录。把来源名称或相关术语写成句子的一部分。例如,“根据 W3C 对横排中西文间距的说明,可以分别处理中文标点和混排文字的空白。”

转述采用自己的表达,并保留来源中的适用条件和限制。若使用原话,只取说明问题需要的部分,标出来源与上下文。政策条文、许可证和界面提示中有固定文字时,保留正式拼写与标点。

区分引用和示例输出

行内短引文可以用中文引号。显示一整段原话时用 Markdown 引用块,并在紧邻的句子中指出来源。需要复制或准确对照的命令输出用代码块,给出对应输入、版本和状态。

设置页在生成成功时显示“索引已生成”。按[验证结果](/docs/examples/recipes#验证结果并检查边界)小节的步骤可以重现这个检查。

引用块可保留原有段落关系。文档自己的强调、条件和警告可使用对应的说明与提示。

选择有明确用途的延伸阅读

解释一个术语时,选读者能在同一语境中使用的定义。需要比较多个资料时,在句中交代每个资料帮助完成什么,例如排版背景、组件写法或版本流程。链接到会随时间变化的来源时记录必要的版本。对旧文、翻译和原文之间出现的差异按审阅译文查证。