NumPy 如何編寫(xiě)操作指南

操作方法應(yīng)當(dāng)直截了當(dāng)，例如：

• 回答一個(gè)重點(diǎn)問(wèn)題。
• 將廣泛的問(wèn)題縮小為用戶(hù)可以選擇的重點(diǎn)問(wèn)題。

當(dāng)陌生人問(wèn)：

“我需要給我的車(chē)加油……”

給出一個(gè)簡(jiǎn)單但明確的答案

• “3公里處，在XXX街口右轉(zhuǎn)，加油站就在你的左邊?！?/li>

給新來(lái)者添加有用的詳細(xì)信息（"xxx街口"，即使它是 3 公里處的唯一岔路口）。但不是不相關(guān)的：

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

如果有相關(guān)背景（教程、解釋、參考、替代方法等），請(qǐng)通過(guò)鏈接（“來(lái)自幾號(hào)公路的路線(xiàn)”、“為什么加油站這么少”）引起用戶(hù)的注意。

委托

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

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

如果問(wèn)題很廣泛，請(qǐng)縮小范圍并重定向

“我想看風(fēng)景?！?/p>

該看的景點(diǎn)如何對(duì)應(yīng)該鏈接到一組窄如何渡的：

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

這些可能反過(guò)來(lái)鏈接到更窄的操作指南，例如市中心頁(yè)面可能會(huì)鏈接到：

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

如果步驟很多，分解

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

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

為什么要編寫(xiě)操作指南？

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

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

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

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

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