做出好榜样

为 Q＆A 创建良好示例的大多数指导都会延伸到文档中。

• 尽量减少并达到目的。并发症和离题是适得其反的。

• 包括工作代码和散文解释。这两者都不够。

• 不要依赖外部数据来获取数据。如果可能，生成数据或使用数据集库：

  library(help = "datasets")
  

在 Docs 的上下文中还有一些额外的考虑因素：

• 只要相关，请参阅像 ?data.frame 这样的内置文档。SO Docs 不是试图替换内置文档。确保新 R 用户知道内置文档以及如何找到它们非常重要。

• 将适用于多个示例的内容移至备注部分。