How to pick right words in technical document
從 0 開始學習技術寫作 #4-如何挑選技術文件的用字 (Wording)
寫技術文件時,要確保使用的單字 (Word) 是夠常見的。
如何知道呢? 可以
測試使用者: 詢問代表使用者是否理解 (例如合作客戶、公司內部其他部門的使用者)
使用工具調查
有哪些工具可以使用呢? 推薦使用以下 6 種:
iWeb Corpus (很難用)
1000 Most Common English Words (比較像英文學習網站)
Plain English Campaign (比較像英文學習網站)
Simplified Technical English (guidelines, 但不是很實用)
Google Ngram
方法: 輸入字詞搜尋
結果: 可看到 by 年份的網路搜尋曲線圖
案例: 輸入 2-3 個字詞,可比較字詞取現圖的差異
Google Trends
方法: 選擇國家 > 輸入字詞
結果: 可看到 (1) 搜尋熱度趨勢變化 (2) 國家區域的感興趣程度 (3) 相關主題 (4) 相關搜尋
案例: 在曲線圖上跟 Google Ngram 相同,但多出了「國家區域的感興趣程度」可以比較
PreviousBasic rules for writing technical documentationNextHow to write a good API documentation? API documentation tutorials recommendation
Last updated