如何撰写 NumPy 使用指南#
使用指南直击要害 - 它们
回答一个集中问题，或
将一个广泛的问题缩小为用户可以选择的一系列集中问题。
一个陌生人问路…#
“我需要给车加油。”
给出简明但明确的答案#
“三公里/英里，在 Hayseed 路右转，就在你左手边。”
为新手添加有用的细节（“Hayseed 路”，即使它是三公里/英里处唯一的岔路）。但不要添加无关的信息
不要给出从 7 号公路出发的路线。
不要解释为什么这个小镇只有一个加油站。
如果有相关的背景信息（教程、解释、参考、替代方法），请使用链接将它们提供给用户（“从 7 号公路出发的路线”、“为什么加油站这么少？”）。
委托#
“三公里/英里，在 Hayseed 路右转，跟着路标走。”
如果信息已经记录并且简洁到足以用作使用指南，则只需链接到它，可能在介绍后加上链接（“三公里/英里，右转”）。
如果问题很广泛，请缩小范围并重新定向#
“我想看看这里的景点。”
“看看景点”使用指南应该链接到一组更窄的使用指南
寻找历史建筑
寻找风景优美的观景点
寻找市中心
这些指南可能会进一步链接到更窄的使用指南 - 因此市中心页面可能会链接到
寻找法院
寻找市政厅
通过这种方式组织使用指南，你不仅为需要缩小问题范围的人显示了选项，而且还为从更窄的问题开始的用户提供了答案（“我想看看历史建筑”、“去市政厅怎么走？”）。
如果有许多步骤，请将它们分解#
如果一个使用指南有很多步骤
考虑将一个步骤单独提取为一个独立的使用指南并链接到它。
添加小标题。它们可以帮助读者了解即将发生的事情并返回到他们离开的地方。
为什么在有 Stack Overflow、Reddit、Gitter……的情况下还要编写使用指南？#
我们拥有权威的答案。
使用指南让网站对非专家来说不那么令人生畏。
使用指南吸引人们访问网站并帮助他们发现这里其他信息。
创建使用指南可以帮助我们从新的角度看待 NumPy 的可用性。
使用指南和教程不是一回事吗？#
人们经常互换使用“使用指南”和“教程”这两个词，但我们遵循 Daniele Procida 的 文档分类，对它们进行了区分。
文档需要满足用户现有的水平。使用指南 提供即时可用的信息；用户想要复制的步骤，不一定想了解 NumPy。教程 是温馨舒适的信息；用户想要感受 NumPy 的某个方面（同样，可能关心或不关心更深入的知识）。
我们将教程和使用指南与解释区分开来，解释 是旨在提供理解而不是立即帮助的深入探讨，以及参考，参考 提供 NumPy 某个具体部分（如 API）的完整、权威数据，但没有义务描绘更广阔的画面。
有关教程的更多信息，请参阅 学习撰写 NumPy 教程
此页面是使用指南的示例吗？#
是的 - 直到带有问号标题的部分；它们进行了解释，而不是提供指示。在一个使用指南中，它们应该是链接。