如何撰寫 NumPy How-to 指南#

How-to 指南直接切入重點 – 它們

  • 回答一個重點明確的問題,或

  • 將廣泛的問題縮小為使用者可以從中選擇的重點問題。

一位陌生人問路…#

「我需要幫我的車加油。」

給出簡潔但明確的答案#

  • 「三公里/英里,在 Hayseed 路右轉,它就在你的左手邊。」

為新手新增有用的細節(「Hayseed 路」,即使它是三公里/英里處唯一的岔路口)。但不要加入不相關的細節

  • 也不要給從 7 號公路來的路線指示。

  • 不要解釋為什麼鎮上只有一個加油站。

如果有相關的背景資訊(教學、解釋、參考、替代方法),請透過連結將其引起使用者的注意(「從 7 號公路來的路線指示」、「為什麼加油站這麼少?」)。

委派#

  • 「三公里/英里,在 Hayseed 路右轉,按照標誌走。」

如果資訊已經被記錄下來,並且對於 How-to 指南來說足夠簡潔,只需連結到它,可能在介紹之後(「三公里/英里,右轉」)。

如果問題很廣泛,縮小範圍並重新導向它#

「我想觀光。」

觀光 How-to 指南應連結到一組範圍更小的 How-to 指南

  • 尋找歷史建築

  • 尋找風景優美的觀景點

  • 尋找市中心

而這些又可能連結到範圍更小的 How-to 指南 – 因此市中心頁面可能連結到

  • 尋找法院

  • 尋找市政廳

透過這種方式組織 How-to 指南,您不僅為需要縮小問題範圍的人顯示了選項,還為從範圍較小的問題開始的使用者提供了答案(「我想看歷史建築」、「去市政廳怎麼走?」)。

如果步驟很多,請將它們分解#

如果 How-to 指南有很多步驟

  • 考慮將一個步驟分解為單獨的 How-to 指南並連結到它。

  • 包含子標題。它們幫助讀者掌握接下來的內容,並回到他們離開的地方。

當有 Stack Overflow、Reddit、Gitter…時,為什麼還要撰寫 How-to 指南?#

  • 我們有權威的答案。

  • How-to 指南使網站對非專家來說不那麼令人生畏。

  • How-to 指南將人們帶入網站,並幫助他們發現此處的其他資訊。

  • 建立 How-to 指南幫助我們以新的眼光看待 NumPy 的可用性。

How-to 指南和教學不是同一件事嗎?#

人們交替使用「how-to 指南」和「教學」這兩個術語,但我們區分了它們,遵循 Daniele Procida 的 文件分類法

文件需要滿足使用者的需求。How-to 指南提供完成任務的資訊;使用者想要複製的步驟,不一定想要理解 NumPy。教學是溫馨的資訊;使用者想要感受 NumPy 的某些方面(並且同樣,可能並不關心更深入的知識)。

我們將教學和 How-to 指南都與說明區分開來,說明旨在提供理解而不是立即的幫助,而參考則提供關於 NumPy 某些具體部分(例如其 API)的完整、權威的資料,但不一定要描繪更廣泛的圖景。

有關教學的更多資訊,請參閱 學習撰寫 NumPy 教學

此頁面是 How-to 指南的範例嗎?#

是的 – 直到帶有問號標題的章節;它們解釋而不是給出指示。在 How-to 指南中,這些將是連結。