工作文档格式

工作文档格式

谨以此系列向IETF的RFC1系列致敬。

Yeonji的工作文档将以类似于本文的笔记形式发布。 这一系列文档的基本规则是：畅所欲言，不代表任何组织或官方的立场。 为了强调这一点，特此使用”征求意见稿（Request For Comments）”作为本系列标签2。

内容1

设立此系列主要有以下几点考量： 首先，人们会倾向于将公开发表的文章当成事实上的标准，而本系列希望通过交流和讨论来推动内容的发展。 其次，人们通常不愿意发表未经雕琢的文章，而本系列的目的之一即为在某种程度上消除这种顾虑。

出于以上考虑，本工作文档系列中可以包含想法、建议等任何内容。 内容以保持内容时效性和准确性为重点，不过分追求华丽的辞藻。 对字数不做限制，但每篇工作文档应至少应包含完整的一句话。 除认真的探讨以外， 没有举出实例或者细节的纯粹立场观点的表述； 提出特别的建议或执行方式但没有给出相关背景解释； 明白的提出一个问题而没有给出任何解答， 诸如此类内容也是本系列可以接受的内容。

格式

每篇工作文档都应该包括下列信息1：

  1. YRFC编号
  2. 作者及合作人
  3. 日期
  4. 题目

本系列的题目不要求全局唯一。 题目前方加注”(YRFC-X)”，其中X是一个序列号。 序列号由Yeonji给出，每个序列号只能用于一篇工作文档。

投稿

本系列名义上可以由任何人投稿并发布。 由Yeonji个人负责判断是否接受投稿。

Yeonji未必会保留所有投稿，如有需要请自行留存副本。

参考文献

  1. Steve Crocker, “Documentation conventions”, Request for Comments, RFC 3, April 1969, DOI: 10.17487/RFC0003 https://www.rfc-editor.org/info/rfc3, https://rfc-editor.org/rfc/rfc3.txt ↩ ↩2 ↩3

  2. J. Postel, J. Reynolds, “Request for Comments reference guide”, Request for Comments, RFC 1000, March 1987, DOI: 10.17487/RFC1000 https://www.rfc-editor.org/info/rfc1000, https://rfc-editor.org/rfc/rfc1000.txt ↩

yrfc