文档风格规范¶

每一个 Wiki 都有自己的文档风格，我们希望 Wiki 这一个整体在风格上是统一的，这样不仅方便读者阅读与学习，也可以帮助贡献者更好地编写文档。

以下是本文档的风格指南。好的风格指南需要在编写中不断积累、不断讨论，因此本文档也会不断更新。我们把CUDA编程基础作为本文的示例并定期修订，以便更好地说明风格指南，您可以参考该文档进行写作。

目标受众¶

Wiki 的目标受众是刚刚接触 HPC 的新手，因此我们的文档应该尽可能地简单易懂，尽可能出展示 HPC 的 Big Picture。在覆盖必要的、不容易掌握的细节的同时，应鼓励读者自行探索其他细节。对于 HPC 应用方面的高级文档（如MLSys方面的文档），我们可以认为读者已经具备一定的 HPC 基础知识，可以以更加专业的方式进行阐述。

行文结构¶

Wiki 的文档应该具有良好的行文结构，以便读者快速地获取信息。我们推荐使用以下结构：

• 简介：简介部分应该包含对该文档的简要介绍，以及该文档的目标受众。简介部分应该尽可能地简短，以便读者快速地了解该文档的内容。
• 背景：背景部分应该包含该文档所涉及的背景知识，以及该文档所涉及的相关概念。背景部分应该尽可能地简短，以便读者快速地了解该文档所涉及的背景知识。
• 内容：内容部分应该包含该文档的主要内容，以及该文档的主要内容的详细介绍。内容部分应该尽可能地详细。
• 总结：总结部分应简短地总结该文档的主要内容，以及该文档的主要内容的重点。
• 任务：对于教程类的文档，我们原创或者整理推荐一些适合练手的项目，以便读者巩固所学的知识。项目预计用时以2~4小时为宜。