如何寫好網(wǎng)站幫助文檔?

document

一翎猛、清楚自己的用戶是哪些人胖翰?

首先弄清楚自己的用戶是誰,是寫好文檔的第一步办成。了解你的用戶泡态,才能做出更好的引導(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)向:不會給人跑題不說重點的感覺

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末雷猪,一起剝皮案震驚了整個濱河市睛竣,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌求摇,老刑警劉巖射沟,帶你破解...
    沈念sama閱讀 221,888評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異与境,居然都是意外死亡验夯,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,677評論 3 399
  • 文/潘曉璐 我一進店門摔刁,熙熙樓的掌柜王于貴愁眉苦臉地迎上來挥转,“玉大人,你說我怎么就攤上這事共屈“笠ィ” “怎么了?”我有些...
    開封第一講書人閱讀 168,386評論 0 360
  • 文/不壞的土叔 我叫張陵拗引,是天一觀的道長借宵。 經(jīng)常有香客問我,道長寺擂,這世上最難降的妖魔是什么暇务? 我笑而不...
    開封第一講書人閱讀 59,726評論 1 297
  • 正文 為了忘掉前任,我火速辦了婚禮怔软,結(jié)果婚禮上垦细,老公的妹妹穿的比我還像新娘。我一直安慰自己挡逼,他們只是感情好括改,可當(dāng)我...
    茶點故事閱讀 68,729評論 6 397
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著家坎,像睡著了一般嘱能。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上虱疏,一...
    開封第一講書人閱讀 52,337評論 1 310
  • 那天惹骂,我揣著相機與錄音,去河邊找鬼做瞪。 笑死对粪,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的装蓬。 我是一名探鬼主播著拭,決...
    沈念sama閱讀 40,902評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼牍帚!你這毒婦竟也來了儡遮?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,807評論 0 276
  • 序言:老撾萬榮一對情侶失蹤暗赶,失蹤者是張志新(化名)和其女友劉穎鄙币,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體蹂随,經(jīng)...
    沈念sama閱讀 46,349評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡爱榔,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,439評論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了糙及。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片详幽。...
    茶點故事閱讀 40,567評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖浸锨,靈堂內(nèi)的尸體忽然破棺而出唇聘,到底是詐尸還是另有隱情,我是刑警寧澤柱搜,帶...
    沈念sama閱讀 36,242評論 5 350
  • 正文 年R本政府宣布迟郎,位于F島的核電站,受9級特大地震影響聪蘸,放射性物質(zhì)發(fā)生泄漏宪肖。R本人自食惡果不足惜表制,卻給世界環(huán)境...
    茶點故事閱讀 41,933評論 3 334
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望控乾。 院中可真熱鬧么介,春花似錦、人聲如沸蜕衡。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,420評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽慨仿。三九已至久脯,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間镰吆,已是汗流浹背帘撰。 一陣腳步聲響...
    開封第一講書人閱讀 33,531評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留万皿,地道東北人骡和。 一個月前我還...
    沈念sama閱讀 48,995評論 3 377
  • 正文 我出身青樓,卻偏偏與公主長得像相寇,于是被迫代替她去往敵國和親慰于。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,585評論 2 359

推薦閱讀更多精彩內(nèi)容