如何撰写 NumPy 操作指南#
操作指南直奔主题——它们
回答一个集中的问题,或
将一个宽泛的问题缩小为用户可以选择的集中问题。
一位陌生人问路…
“我需要给汽车加油。”
给出简短但明确的答案#
“三公里/英里,在 Hayseed 路右转,就在你左边。”
为新来者添加有用的细节(“Hayseed 路”,即使它是三公里/英里处唯一的岔路口)。但不要添加无关的细节
不要也给出从 7 号公路来的路线。
不要解释为什么镇上只有一个加油站。
如果有关联的背景信息(教程、解释、参考、替代方法),请通过链接引起用户的注意(“从 7 号公路来的路线”、“为什么加油站这么少?”)。
委托#
“三公里/英里,在 Hayseed 路右转,跟着指示牌走。”
如果信息已经文档化且足够简洁,可以像操作指南一样使用,只需链接到它,也许在介绍之后(“三公里/英里,右转”)。
如果问题很宽泛,请缩小范围并重定向#
“我想看看景点。”
“看看景点” 操作指南应链接到一组更窄的操作指南
寻找历史建筑
寻找风景优美的观景点
寻找市中心
这些操作指南又可能链接到更窄的操作指南——因此市中心页面可能链接到
寻找法院
寻找市政厅
通过这种方式组织操作指南,您不仅为需要缩小问题范围的人展示了选项,还为从较窄问题开始的用户提供了答案(“我想看历史建筑”、“去市中心怎么走?”)。
如果步骤很多,请将其分开#
如果一个操作指南有很多步骤
考虑将一个步骤分解成一个单独的操作指南并链接到它。
包含子标题。它们可以帮助读者了解接下来的内容并回到他们离开的地方。
既然有 Stack Overflow、Reddit、Gitter……,为什么还要写操作指南?#
我们有权威的答案。
操作指南使网站对非专家来说不那么令人生畏。
操作指南吸引人们来到网站,并帮助他们发现这里存在的其他信息。
创建操作指南有助于我们以新的视角看待 NumPy 的可用性。
操作指南和教程是一回事吗?#
人们互换使用“操作指南”和“教程”这两个词,但我们根据 Daniele Procida 的文档分类法来区分。
文档需要满足用户当前的需求。操作指南提供“立即完成”的信息;用户想要可以复制的步骤,不一定想理解 NumPy。教程是“温暖模糊”的信息;用户想要对 NumPy 的某个方面有感觉(同样,他们可能关心或不关心更深入的知识)。
我们将教程和操作指南与解释区分开来,解释是旨在提供理解而非即时帮助的深入探讨;而参考则提供 NumPy 某个具体部分的完整、权威的数据(如其 API),但不一定需要描绘更广泛的图景。
关于教程的更多信息,请参阅学习编写 NumPy 教程
此页面是否是操作指南的示例?#
是的——直到带有问号标题的部分;它们是解释而不是提供说明。在操作指南中,这些会是链接。