一翎猛、清楚自己的用戶是哪些人胖翰?
首先弄清楚自己的用戶是誰,是寫好文檔的第一步办成。了解你的用戶泡态,才能做出更好的引導(dǎo),告訴他們?yōu)槭裁催@樣以及怎么做迂卢?
針對不同的群體要有不同的寫作側(cè)重點某弦。如果是給運維人員看的,那么重點是要說清楚各個操作以及相關(guān)邏輯而克;如果是給非技術(shù)人員看的靶壮,一定要盡量『看圖說話』,聯(lián)系他們能夠理解的概念來跨越不同職業(yè)的鴻溝员萍。
二腾降、列出總的分類和大綱。
先列出總的分類碎绎,根據(jù)分類寫出需要寫哪些類型的文章螃壤,列出大綱。
三筋帖、寫初稿奸晴。
寫作中可以多使用的幾種方式:
(1)總分總結(jié)構(gòu):文章可以使用總分總結(jié)構(gòu),因為這種文章結(jié)構(gòu)非常符合人類的思維習(xí)慣日麸。
(2)一圖勝千言:涉及到諸多難以解釋的概念和聯(lián)系時寄啼,不要過多解釋,畫一個清晰的圖,比什么效果都好墩划。如果是針對小白的使用教程涕刚,就把每一個需要使用的功能,按照真實的使用步驟乙帮,逐步進行詳細(xì)的截圖說明和講解杜漠。
(3)少即是多:文檔太長,自己更新起來累察净,別人看起來也累碑幅,維護起來更累。所以去掉各類廢話塞绿、套話沟涨,說重點。
(4)注意排版:突出重點异吻,讓結(jié)構(gòu)顯得清晰飽滿裹赴。
四、更新迭代
根據(jù)網(wǎng)站實際功能的變化诀浪,隨變化更新迭代棋返。保證及時更新。
一份好文檔的標(biāo)準(zhǔn):
(1)準(zhǔn)確:不會給人模棱兩可的感覺
(2)清晰:不會給人寫了很多但不知道寫了啥的感覺
(3)完整:不會給人話說到一半戛然而止的感覺
(4)簡潔:不會給人沒話找話說的感覺
(5)有組織:不會給人不知道要去哪里看什么內(nèi)容的感覺
(6)可讀性好:不會給人每個字都認(rèn)識但就是看不懂的感覺
(7)任務(wù)導(dǎo)向:不會給人跑題不說重點的感覺