如何编写 NumPy 操作指南#
操作方法开门见山——他们
回答一个重点问题,或者
将广泛的问题缩小为用户可以选择的重点问题。
一个陌生人问路…… #
“我需要给我的车加油。”
给出一个简短但明确的答案#
“三公里/英里,在 Hayseed Road 右转,它就在您的左边。”
为新来者添加有用的详细信息(“Hayseed Road”,即使它是唯一的 3 公里/英里的岔路)。但不是无关紧要的:
也不要给出来自 7 号公路的指示。
不要解释为什么镇上只有一个加油站。
如果有相关背景(教程、解释、参考、替代方法),请通过链接引起用户注意(“从 7 号公路出发的路线”、“为什么加油站这么少?”)。
代表#
“三公里/英里,在 Hayseed Road 右转,按照路标行驶。”
如果信息已经记录下来并且足够简洁,可以作为操作方法,只需链接到它,可能是在介绍之后(“三公里/英里,右转”)。
如果问题很宽泛,缩小范围并重新定向#
“我想go看看风景。”
“查看景点”指南应链接到一组范围更窄的指南:
寻找历史建筑
寻找风景优美的观景台
找到镇中心
这些可能反过来链接到更窄的操作方法 - 因此市中心页面可能链接到
找到法院大楼
找到市政厅
通过以这种方式组织操作指南,您不仅可以为需要缩小问题范围的人显示选项,还可以为从较小范围问题开始的用户提供答案(“我想看看历史建筑”、“go城市的路怎样走”)大厅?”)。
如果有很多步骤,请将它们分解#
如果操作方法有很多步骤:
考虑将一个步骤分解为单独的操作方法并链接到它。
包括副标题。它们帮助读者掌握即将发生的事情并返回他们上次停下的地方。
既然有 Stack Overflow、Reddit、Gitter……,为什么还要写操作指南呢?#
我们有权威的答案。
操作指南使该网站对非专家不再那么令人生畏。
操作指南将人们带入网站并帮助他们发现此处的其他信息。
创建操作指南可以帮助我们以新的视角看待 NumPy 的可用性。
方法和教程不是一回事吗?#
人们可以互换使用“操作方法”和“教程”这两个术语,但我们按照 Daniele Procida 的文档分类法进行了区分。
文档需要满足用户的需求。 操作方法提供如何完成的信息;用户想要复制步骤,但不一定想要了解 NumPy。教程是温暖模糊的信息;用户想要感受 NumPy 的某些方面(同样,可能或可能不关心更深入的知识)。
我们将教程和操作方法与解释(Explanations)和参考资料(References)区分开来,解释(Explanations)是深入研究,旨在提供理解而不是立即帮助,参考资料(References)提供有关 NumPy 某些具体部分(如其 API)的完整、权威数据,但没有义务描绘更广阔的图景。
有关教程的更多信息,请参阅学习编写 NumPy 教程
此页面是操作方法的示例吗?#
是的——直到带有问号标题的部分;他们解释而不是给出指示。在操作方法中,这些将是链接。