1. 主页
  2. 文档
  3. Fuchsia OS 简体中文文档 (2019年版)
  4. 最佳实践
  5. 文档标准

文档标准

文档标准

为做了需要文档化的事情的人提供的一份关于文档写什么以及如何写的文档。

为什么要写文档?

Fuchsia 是一个新的操作系统。随着项目的发展和新成员的加入提供有效文档资源的需求也随之增长。

受众是谁?

这里记录的文档是面向技术人员的,即那些希望实现或运行 APIs 或了解操作系统内部动态的人。这些标准不适用于为最终用户产品提供的文档。

我应该写什么内容?

简而言之,记录你的程序接口,介绍基本概念,解释所有东西是如何结合在一起的。

  • 约定:例如,本文档是关于文档、代码样式
  • 系统设计:例如,网络堆栈、compositor、内核、assumptions
  • APIs:例如,FIDL 接口、库函数、系统调用
  • 协议:例如,schemas、编码、wire formats、配置文件
  • 工具:例如,“bootserver”、“netcp”、“fx”
  • 工作流程:例如,环境设置、测试方法、在何处查找各个部分、如何完成工作

文档保存到哪里?不同文档如何存放?

将文档资源保存在源代码中它们所描述的内容附近。文档应该放在哪里取决于它的类型和主题。(详见以下章节)

文档

文档在解释大思想和演示如何执行特定任务方面特别有效。它非常适合记录系统设计、协议、工具、约定、工作流和教程。

优先存放位置

  • 有关特定项目的文档应放到该项目存储库根目录下的“docs”文件夹,并按主题排列。例如,//apps/my-project/docs/my-feature.md
  • 关于 Fuchsia 整体的文档应该放到最外层存储库中的“docs”文件夹。例如,//docs/build_packages.md

备选存放位置

  • 在项目存储库的根目录中添加“README.md”可以为第一次访问项目的人做简要介绍,但这不是必需的。

写出有效文档的技巧:

  • 写纯英文文本。
  • 优化初次读者的体验。
  • 给每份文档一个清晰的标题。
  • 简要描述每个部分的目的和基本假设。
  • 一定要定义标准术语,不要使用过多的缩写。
  • 要包含到其他相关文档的链接。
  • 不要偏离主题。
  • 使用小标题组织思路。
  • 使用非正式的口吻。
  • 不要赘述已经在别处写过的 API 文档。(例如,文档注释已写)

文档注释

文档注释在描述接口、结构、方法、数据类型和程序代码的其他元素的用途时特别有效。

所有开发使用的 APIs 都应该添加文档注释,因为它们对于SDK用户来说是一项很有用的资产。

写出有效文档注释的技巧:

  • 写纯英文文本。
  • 写出完整的句子和段落。
  • 保持注释简洁明了,不超过几句话。
  • 遵循编程语言指南中的样式。
  • 总是增量来写;不要赘述类型签名已经表示过的内容。
  • 描述度量单位和变量的完整性约束。
  • 链接到文档以更详细地描述 APIs 是如何作为一个整体组合在一起的。

面包屑

文档只有在你的读者能够找到它时才有用。添加指向或来自现有文档中的链接会大大提高别人阅读到它的可能性。

写面包屑的技巧

  • 自顶向下链接:添加从范围更广的文档到更详细文档的链接,以帮助读者了解有关特定主题的更多信息。这Fuchsia book就是一个很好的自顶向下链接的起点。
  • 自底向上链接:添加从更详细的文档到范围更广文档的链接,以帮助读者更好地了解所讨论主题的总体上下文。在模块、类或接口级文档注释中添加到更高级别概述文档的链接会特别有效。
  • 横向链接:添加读者应该先熟悉的相关主题文档的链接,以便更好地理解你写的文档内容。

本文 GitHub 链接为:https://github.com/FuchsiaOS/FuchsiaOS-docs-zh_CN/blob/master/best-practices/documentation_standards.md

翻译者:drawf (https://github.com/drawf

这篇文章对您有用吗?

我们要如何帮助您?

Comments

Leave a reply

您的电子邮箱地址不会被公开。