28、软件开发文档与NumPy使用指南

软件开发文档与NumPy使用指南

1 软件前期准备与文档类型

1.1 安装与配置

在用户使用软件前，需要获取并配置好软件。获取代码是第一步，分发代码的方式不同，用户获取代码的途径也不同，有时只需一行简单命令，有时则需先获取版本控制软件等其他应用来获取最新代码。

1.2 教程

用户获取应用后，通常希望立即了解如何使用。教程是引导用户了解应用最常用功能的好方法，能展示应用的优势，尤其对于库和框架，能让用户快速感受其对自身代码的帮助。

1.3 参考文档

当用户对应用有一定了解并积累了一些使用经验后，他们需要提醒信息，如所有功能如何工作、功能间如何协作以及如何与实际任务集成。不同读者对参考文档的形式有不同偏好，作者需确定最适合应用的文档类型。对于简单应用，教程可能就足以说明所有可用功能。

2 文档工具与reStructuredText

2.1 文档实用工具

文档编写中，格式化、引用和展示等任务会消耗大量时间和精力。第三方 docutils 包提供了一套全面的工具，其中 reStructuredText （ReST或RST）是核心。它是一种用于编写技术文档的标记语言，采用“所见即所想”（WYSIWYM）方法，与传统的“所见即所得”（WYSIWYG）不同，能将内容与展示分离，专注于文档的核心内容。

2.2 reStructuredText的特点

• 可读性 ：遵循Python哲学，始终注重可读性，文档结构