NumPy 如何编写操作指南

操作方法应当直截了当，例如：

• 回答一个重点问题。
• 将广泛的问题缩小为用户可以选择的重点问题。

当陌生人问：

“我需要给我的车加油……”

给出一个简单但明确的答案

• “3公里处，在XXX街口右转，加油站就在你的左边。”

给新来者添加有用的详细信息（"xxx街口"，即使它是 3 公里处的唯一岔路口）。但不是不相关的：

• 不要从几号公路发出指示。
• 不要解释为什么只有一个加油站。

如果有相关背景（教程、解释、参考、替代方法等），请通过链接（“来自几号公路的路线”、“为什么加油站这么少”）引起用户的注意。

委托

• “三公里在XXX接口右转，按照指示牌走。”

如果信息已经记录在案并且简洁明了，可以链接到它，可能在介绍之后。（“三公里，向右走”）

如果问题很广泛，请缩小范围并重定向

“我想看风景。”

该看的景点如何对应该链接到一组窄如何渡的：

• 寻找历史建筑。
• 寻找风景优美的瞭望台。
• 寻找市中心。

这些可能反过来链接到更窄的操作指南，例如市中心页面可能会链接到：

• 找到法院。
• 找到市政厅。

如果步骤很多，分解

如果操作方法有很多的步骤：

• 考虑将一个步骤分解为单独的操作方法并链接到它。
• 包括副标题。它们可以帮助读者掌握即将发生的事情从他们离开的地方返回。

为什么要编写操作指南？

• 有权威的答案。
• 操作方法使网站对非专家不那么令人生畏。
• 操作指南将人们带入站点，并帮助他们发现此处的其他信息。

操作指南和教程是一回事吗？

人们交替使用“操作方法”和“教程”人们交替使用术语“操作方法”和“教程”，但我们根据 Daniele Procida 的文档分类法进行区分。

文档需要满足用户的需求。 How-tos提供完成信息；用户想要复制步骤并且不一定想要理解 NumPy。教程是温暖的模糊信息；用户想要感受 NumPy 的某些方面（同样，可能关心也可能不关心更深入的知识）。

我们将教程和操作方法与Explanations和References区分开来，后者是旨在提供理解而不是立即帮助的深入研究，而References则提供关于 NumPy 的某些具体部分（如其API）的完整、自主的数据，但没有义务描绘更广阔的画面。