說明文檔撰寫3個步驟和7個要點

說明文檔撰寫的3個步驟和7個重點向來在糾結一件事情，操作手冊該是產(chǎn)品寫仍是營運寫，結果仍是落在了產(chǎn)品的頭上，一世第一次寫操作手冊，一個功能很錯亂的在線軟件教育平臺，以下分享一下制作過程中的血和淚。按步驟來：第一，需要把系統(tǒng)摸得很透辟這個項目從前不是我經(jīng)手的，我是人后媽，沒啥感情，人親爸跳槽去了其他企業(yè)，留下舉目無親的項目孩兒(。?＿?。)?）因此說項目的向來性很重要，不是你親生的，帶起來那叫一個累！抓住全部機會向項目經(jīng)理討教！項目經(jīng)理是繼產(chǎn)品經(jīng)理今后對這個項目認識最深的人了，問底下的程序員，平常得到的結論就是........反正就是說不清，還不如直接跳過項目經(jīng)理告訴我平臺的主要功能亮點，今后我就開始編寫操作手冊。step1：操作手冊第一點就是平臺簡介，平常這東西沒什么人回去看，可是也不乏那么兩三個閑的沒事干的回去撇兩眼，因此簡介必然要寫的簡短了然、平常易懂，把項目的特點功能最好是分段拎出來獨自夸它一夸。step2：功能架構圖，這個部分很重要！平常商務拿操作手冊給客戶看的時候客戶都是看看架構圖，后邊的內(nèi)容都是以浮光掠影式的掠過，因此這可以說是封面今后的第二張臉，超級重要，無論是內(nèi)容仍是雅觀性都要求很高。介紹一個懶人方法，我用的是word2013很簡單的一個圖標制作器，文字內(nèi)容增添也很方便。架構圖不需要論述得過分仔細，平常抵達二級功能就差不多了，過分仔細會顯得系統(tǒng)很肥胖，自然太簡略也是不可以的，這是真金白銀賣給人客戶的呀。我是依據(jù)角色區(qū)分的，真切圖片不便顯露，大體就是這樣：step3：由于平臺的角色功能性質(zhì)，因此在登錄模塊需要把三種角色的登錄詳盡挨次介紹要交代清楚登錄的網(wǎng)址差別，以界面不同樣來區(qū)分仍是以tab頁的選擇不同樣來區(qū)分，要挨次介紹清楚。要考慮用戶的接受能力，不是每個用戶都能像你同樣拿著個新應用就能熟門熟路的立刻上手。step4：以角色名稱作為一級標題，將功能作為二級標題，這樣無論是電子檔仍是紙質(zhì)的都能做到簡短了然，一眼就能卻分各個角色之間的不同樣step5：介紹功能使用的時候都需要用到截圖，當一張圖片中同時出現(xiàn)多個功能點時，我使用序號來加以區(qū)分，再今后再用文字來論述序號處的詳盡功能。step6：今后就是看你的文字功底了，不需要像寫作同樣辭藻華美，操作手冊講究的是適用，全部的詞語要求白話式，就是識字的人都能懂的樣子。step7：格式問題！一開始寫的時候沒把它放在心上，想著只需目錄是清楚的內(nèi)部格式等寫完今后再來調(diào)。等到我寫完今后才悔不妥初，看著整齊的目錄，此后是大小粗細烏七八糟的內(nèi)容的時候頭都大了。由于格式問題，這份操作手冊就在我和商務之間過手無數(shù)遍，自己做的東西平常自己找起茬來都很困難，就像自己的孩子都是圓滿的，會挑三揀四的都是他人的媽。這時候word的格式功能特別重要，百般改正今后我一狠心把全文的格式通通改成了正文形式，此后再新建各個目錄級的款式、圖片款式、內(nèi)容款式等等，一頓折騰今后總算是大功成功了。提到格式就必然得提到排版問題。操作手冊中會出現(xiàn)好多的圖片，圖片大小不一，所占的篇幅也不同樣樣，因此會出現(xiàn)某段文字今后是一大片的空白，下一頁開始就是一張巨大特其他圖片，這樣影響雅觀，也關乎成本。因此圖片該減小的時候就不要心軟，可以調(diào)整圖片的嵌套格式，使其盡量切近文字，實在不可以的話就把從前的圖片適合的放大一點，使其底部的空白處減少。操作文檔看著簡單，其實要求作者對系統(tǒng)的全面認識，每個細節(jié)都要解說到位是一件