如何编写 NumPy 操作指南#

操作指南直奔主题——它们

  • 回答一个重点突出问题,或

  • 将一个宽泛的问题细化为用户可以从中选择的重点问题。

一位陌生人问路……#

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

给出简明扼要的明确答案#

  • “三公里/英里,在 Hayseed 路右转,它在你的左边。”

为新用户添加有用的详细信息(“Hayseed 路”,即使它是三公里/英里处唯一的岔路)。但不要无关紧要的信息

  • 不要同时给出从 7 号公路出发的路线。

  • 不要解释为什么镇上只有一个加油站。

如果有相关的背景信息(教程、解释、参考、替代方法),通过链接(“从 7 号公路出发的路线”、“为什么加油站这么少?”)引起用户注意。

委托#

  • “三公里/英里,在 Hayseed 路右转,跟着指示牌走。”

如果信息已经有文档记录并且对操作指南来说足够简洁,只需链接到它,可能在介绍之后(“三公里/英里,右转”)。

如果问题宽泛,则将其细化并重定向#

“我想看看风景名胜。”

看风景名胜》操作指南应链接到一系列更具体的操作指南

  • 寻找历史建筑

  • 寻找风景瞭望台

  • 寻找市中心

而这些又可能链接到更具体的操作指南——因此市中心页面可能会链接到

  • 寻找法院

  • 寻找市政厅

通过这种方式组织操作指南,您不仅为需要细化问题的人展示了选项,还为那些一开始就提出更具体问题(“我想看看历史建筑”、“市政厅怎么走?”)的用户提供了答案。

如果步骤很多,请将其分解#

如果一个操作指南包含许多步骤

  • 考虑将某个步骤分解为一个独立的操作指南并链接到它。

  • 包含小标题。它们帮助读者了解即将到来的内容,并返回他们离开的地方。

既然有 Stack Overflow、Reddit、Gitter 等,为什么还要编写操作指南?#

  • 我们有权威的答案。

  • 操作指南使该网站对非专家来说不那么令人生畏。

  • 操作指南将人们带入网站,并帮助他们发现此处的其他信息。

  • 创建操作指南有助于我们以新的视角看待 NumPy 的可用性。

操作指南和教程不是一回事吗?#

人们互换使用“how-to”和“tutorial”这两个术语,但我们遵循 Daniele Procida 的文档分类法进行区分。

文档需要满足用户的需求。操作指南提供“即用型”信息;用户想要可复制的步骤,不一定想理解 NumPy。教程是“感受型”信息;用户想要了解 NumPy 某个方面的感觉(同样,可能不关心更深入的知识)。

我们将教程和操作指南与解释(旨在提供理解而非即时帮助的深入探讨)和参考资料(提供 NumPy 某个具体部分(如其 API)的完整、权威数据,但不负责描绘更广泛的图景)区分开来。

有关教程的更多信息,请参阅学习如何编写 NumPy 教程

此页面是操作指南的示例吗?#

是的——直到带有问号标题的章节;它们是解释而不是给出指导。在操作指南中,这些会是链接。