如何寫好一份技術文檔

1.參考尼爾森十大交互原則

2.參考交互設計7大定律

語義一致原則

原理:

大腦適應不同名詞需要耗費時間,通過減少切換開銷來提升閱讀效率

常規(guī)示例:

內(nèi)容1:麥克風陣列的圓周半徑推薦35mm

內(nèi)容2:麥克風陣列可選直徑為60~80mm

改進示例:

將直徑統(tǒng)一成半徑,保持語義一致

內(nèi)容1:麥克風陣列的圓周半徑推薦35mm

內(nèi)容2:麥克風陣列可選半徑為30~40mm


流程最短原則

原理:

減少用戶的切換成本,所見即所得

常規(guī)示例:

改進示例:

將網(wǎng)盤鏈接修改為下載鏈接,減少操作流程

圖文結合

原理:

基于情景,小白用戶按流程操作,無需做文字與圖片的轉(zhuǎn)換

常規(guī)示例:

首先打開文件-->點擊導出為-->點擊本地excel表格(.xlse)

改進示例:

最少冗余原則

原理:

人腦處理速率有限,盡可能降低大腦的信息負擔

常規(guī)示例:

改進示例:

去掉了冗余信息

主線突出原則

原理:

文檔要覆蓋多數(shù)人的需求,少數(shù)異常過程通過鏈接引出

常規(guī)示例:


改進示例:


最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容