如何撰写NumPy操作指南#
操作指南直截了当——它们
回答一个集中式问题,或者
将一个广泛的问题缩小为用户可以选择的一系列集中式问题。
一个陌生人问路……#
“我需要给我的车加油。”
给出简短但明确的答案#
“三公里/英里,在Hayseed路右转,加油站就在你左边。”
为新手添加有用的细节(“Hayseed路”,即使它是三公里/英里处唯一的岔路)。但不要添加无关的信息
不要给出从7号公路来的路线。
不要解释为什么这个镇只有一个加油站。
如果有相关的背景信息(教程、解释、参考、替代方法),请使用链接来提请用户注意(“从7号公路来的路线”、“为什么加油站这么少?”)。
委托#
“三公里/英里,在Hayseed路右转,按照指示牌走。”
如果信息已经记录在案并且足够简洁,可以直接链接到它,可能是在引言之后(“三公里/英里,右转”)。
如果问题很广泛,请缩小范围并重定向#
“我想看看这里的景点。”
“游览景点”操作指南应该链接到一系列更窄的操作指南
寻找历史建筑
寻找风景优美的观景点
寻找市中心
这些又可能链接到更窄的操作指南——因此市中心页面可能链接到
寻找法院
寻找市政厅
通过这种方式组织操作指南,你不仅可以为需要缩小问题范围的人提供选择,还可以为从更窄的问题入手的用户提供答案(“我想看看历史建筑”、“去市政厅怎么走?”)。
如果步骤很多,请将其分解#
如果一个操作指南有很多步骤
考虑将一个步骤分解成一个单独的操作指南并链接到它。
包含小标题。它们可以帮助读者掌握接下来要做什么以及返回他们离开的地方。
当有Stack Overflow、Reddit、Gitter……的时候,为什么还要编写操作指南?#
我们有权威的答案。
操作指南使网站对非专家来说不那么令人生畏。
操作指南将人们带入网站并帮助他们发现这里其他信息。
创建操作指南有助于我们从新的角度看待NumPy的可用性。
操作指南和教程不是一回事吗?#
人们混用“操作指南”和“教程”这两个术语,但我们遵循Daniele Procida的文档分类法来区分它们。
文档需要满足用户的需求。操作指南提供完成任务所需的信息;用户想要复制步骤,并不一定需要理解NumPy。教程是轻松愉快的介绍性信息;用户想要了解NumPy的某些方面(同样,可能关心也可能不关心更深入的知识)。
我们将教程和操作指南与解释区分开来,解释是深入探讨,旨在提供理解而不是直接帮助,以及参考,它提供了NumPy某些具体部分(如其API)的完整、权威的数据,但不一定需要描绘更广阔的画面。
有关教程的更多信息,请参阅学习如何撰写NumPy教程
此页面是操作指南的示例吗?#
是的——直到带有问号标题的部分;它们解释而不是给出方向。在操作指南中,这些将是链接。