文檔善用分頁,每個一級標題/章節結尾處分頁。
表格美觀:將內容設置水平居中+垂直居中
同一內容有兩張圖的命名方式:課程詳情A,課程詳情B
高度概括:對所有的文段,看到標題就能知道內容。
技術方案寫法:在文字、圖片裏體現出技術+此技術在項目裏的運用,禁只介紹技術,不結合具體項目的寫法。
“用戶”應寫成具體的角色名,如學員,教師。
“如下圖所示”應寫成“如圖3-1所示”。
在前言/綜述中應提到用戶痛點。
插入圖片的排版方法:展示整體頁面(如主頁,搜索頁),一行可放2-3張;強調細節/特色功能的可以只放一張大圖。
方向/目標的寫法:禁用功能性名詞(例:採用了xx技術)要用大詞,不能落實到具體的實施方案。
描述XX的解決思路:畫思維導圖
畫圖和排版對齊很重要:例如方框要對齊
改成下圖:
介紹框架/技術寫法:
a. 介紹這個框架是什麼,有啥優點(先進、穩定、成熟 )
b. 在你的項目裏怎麼去用它
c. 帶來了什麼好處避免毫無意義、繁瑣的羅列(如把前後端每個接口都列出來),從審覈方的角度思考,這個內容別人能看到什麼有價值的信息。
畫圖的原則:第一看得清,第二美觀。底色和文字色對比度要高(一深一淺),且不能用同色系。舉例:左邊錯誤,右邊正確。
16. 對出現的每一張圖片/模型都應有文字加以解釋。
17.用詞要準確,如聊天不可擴大爲“社交”。
18.在高級編輯模式下刪除多餘的複製痕跡和回車鍵,不能直接刪除的回車鍵可以試試shift+下方向鍵+刪除。