NumPy 如何編寫操作指南

操作方法應當直截了當，例如：

• 回答一個重點問題。
• 將廣泛的問題縮小為用戶可以選擇的重點問題。

當陌生人問：

“我需要給我的車加油……”

給出一個簡單但明確的答案

• “3公里處，在XXX街口右轉，加油站就在你的左邊。”

給新來者添加有用的詳細信息（"xxx街口"，即使它是 3 公里處的唯一岔路口）。但不是不相關的：

• 不要從幾號公路發(fā)出指示。
• 不要解釋為什么只有一個加油站。

如果有相關背景（教程、解釋、參考、替代方法等），請通過鏈接（“來自幾號公路的路線”、“為什么加油站這么少”）引起用戶的注意。

委托

• “三公里在XXX接口右轉，按照指示牌走。”

如果信息已經(jīng)記錄在案并且簡潔明了，可以鏈接到它，可能在介紹之后。（“三公里，向右走”）

如果問題很廣泛，請縮小范圍并重定向

“我想看風景。”

該看的景點如何對應該鏈接到一組窄如何渡的：

• 尋找歷史建筑。
• 尋找風景優(yōu)美的瞭望臺。
• 尋找市中心。

這些可能反過來鏈接到更窄的操作指南，例如市中心頁面可能會鏈接到：

• 找到法院。
• 找到市政廳。

如果步驟很多，分解

如果操作方法有很多的步驟：

• 考慮將一個步驟分解為單獨的操作方法并鏈接到它。
• 包括副標題。它們可以幫助讀者掌握即將發(fā)生的事情從他們離開的地方返回。

為什么要編寫操作指南？

• 有權威的答案。
• 操作方法使網(wǎng)站對非專家不那么令人生畏。
• 操作指南將人們帶入站點，并幫助他們發(fā)現(xiàn)此處的其他信息。

操作指南和教程是一回事嗎？

人們交替使用“操作方法”和“教程”人們交替使用術語“操作方法”和“教程”，但我們根據(jù) Daniele Procida 的文檔分類法進行區(qū)分。

文檔需要滿足用戶的需求。?How-tos提供完成信息；用戶想要復制步驟并且不一定想要理解 NumPy。教程是溫暖的模糊信息；用戶想要感受 NumPy 的某些方面（同樣，可能關心也可能不關心更深入的知識）。

我們將教程和操作方法與Explanations和References區(qū)分開來，后者是旨在提供理解而不是立即幫助的深入研究，而References則提供關于 NumPy 的某些具體部分（如其API）的完整、自主的數(shù)據(jù)，但沒有義務描繪更廣闊的畫面。