引用

技术文档中使用引用建议遵循以下规范。

  • 当某内容在其他地方已经详细描述过、不适合在正文中再次介绍时,可以使用引用。

  • 对于必须引用但内容很少(少于 100 字)的情况,建议直接在该处重新描述一遍。

  • 必须保证引用的位置准确。

技术文档中引用第三方内容建议遵循以下规范。

  • 引用他人的语句时,应注明出处。

    • 【示例】One man’s constant is another man’s variable. — Alan Perlis

  • 全篇转载时,应在全文开头显著位置注明作者和出处,并链接至原文。

    • 【示例】本文转载自 WikiQuote

  • 使用外部图片时,必须在图片下方或文末标明来源。

    • 【示例】本文部分图片来自 Wikipedia