經(jīng)典word整理文檔，僅參考，雙擊此處可刪除頁眉頁腳。本資料屬于網(wǎng)絡(luò)整理，如有侵權(quán)，請聯(lián)系刪除，謝謝！文檔，不管是對于員工個人，還是對于企業(yè)，都有非常重要的意值，完全可以等同于產(chǎn)品本身?；蛘哒f，技術(shù)文檔就是產(chǎn)品的一個重要組成部分。是不對的。息傳遞的重要工具和載體。不同階段的文檔，有不同的作用。不同的崗位，有不同的文檔體系。書等。在產(chǎn)品工程交付階段，有版本發(fā)布說明、技術(shù)指導(dǎo)書、升級/割接擴容指導(dǎo)書等。部文檔服務(wù)于客戶、合作方等外部用戶。內(nèi)外部文檔密級不同，內(nèi)容會有所刪減，表述方式和側(cè)重點也會有所不同。確性和效率，進而影響工作的完成、項目的交付。例如，產(chǎn)品開通文檔太爛，客戶看不懂，合作方員工看不懂，甚割接。文檔如果出現(xiàn)錯誤，甚至可能造成嚴重的事故?，F(xiàn)在市場競爭越來越激烈。有時候，雖然產(chǎn)品本身做得很好，價格也很有優(yōu)勢，但是文檔太爛，一樣會被客戶鄙視，進而拉低了產(chǎn)品的整體競爭力。有損公司品牌形象。那么，決定產(chǎn)品文檔質(zhì)量的基本要素是什么呢？有人說，是的寫作水平。也有人說，是是否有充足的時間。其實都不對，基本要素只有一個，那就是錢。文檔寫作是一個需要投入大量資源的工作。首先，需要建立一個完善的文檔管理體系，包括文檔架構(gòu)體系，文檔職責歸屬，文檔立項、開發(fā)、評審、發(fā)布、歸檔流程以及對應(yīng)平臺等。工時。再有，文檔和產(chǎn)品開發(fā)一樣，是一個滾動性流程，需要不斷更新迭代。所以，資源投入也是持續(xù)性的。早期的時候，國內(nèi)很多企業(yè)利用人力成本優(yōu)勢，發(fā)起人海戰(zhàn)術(shù)，度）搶占市場。是拿產(chǎn)品設(shè)計指導(dǎo)書改一改，截截圖，就扔給了售后，甚至扔給了客戶。內(nèi)部用戶（售后）罵娘，領(lǐng)導(dǎo)其實心里有數(shù)，畢竟資源有限，只能犧牲文檔保版本，對內(nèi)部反饋進行彈壓。而外部客戶的意見，是無法進行彈壓的。對于一些低端客戶來說，比較關(guān)注的是價格。極端的成本優(yōu)勢，可以讓客戶忽視文檔。但是，對于高端用戶來說，他們對文檔的要求和對產(chǎn)品的要求是一致的。沒有優(yōu)秀齊套的文檔，一樣不給中標。源。然而，一旦項目應(yīng)付過去，資源又會撤走，好不容易建立起來的文檔質(zhì)量，又再次垮塌，如此惡性循環(huán)。所以說，對于企業(yè)，想要把文檔滿意度搞好，樹立有利于產(chǎn)品品這是搞好文檔的基本前提。的資源投入。戰(zhàn)略層面的重視是基礎(chǔ)，戰(zhàn)術(shù)層面的執(zhí)行是關(guān)鍵。架構(gòu)（到底需要多少篇文檔，分別由誰來負責，寫給誰看），小到文完美完成的。檔的寫作技巧。的定位——它是一篇什么性質(zhì)的文檔？寫作目的是什么？它的使用者是誰？文檔的定位，直接決定了整篇文檔的基調(diào)。了解的讀者。然而，又不是小學(xué)生那種層次，而是至少已經(jīng)完成了基識，也有對自然現(xiàn)場的基本認知，還有正常人的邏輯思維能力。外部客戶，是有經(jīng)驗的客戶，還是零基礎(chǔ)的客戶，是已經(jīng)閱讀過前置文檔的客戶，還是第一次看這套文檔的客戶。得懂。戶，讓他試讀，提供反饋意見。那就是邏輯思維能力強。對于寫作來說，這一點非常重要。尤其是技術(shù)文檔的寫作，必須有很強的邏輯思維能力。文檔的總體結(jié)構(gòu)，必須要有邏輯連貫的章節(jié)順序。文檔的語句，類文檔。文科生過于感性的文字，也不適合技術(shù)類文檔。都不懂？”“這是基礎(chǔ)啊，是個人都懂！”然后就偷工減料，言簡意賅，跳過了大量的細節(jié)，忽視了可能出現(xiàn)的不同情況，讓文檔使用者不知所措。甚至有的，喜歡玩“玄學(xué)”，覺得越寫得高深，就越顯得自己很懂，簡直可笑。規(guī)范的技術(shù)文檔，通常會遵循SOP的原則。所謂SOP，就是StandardOperatingProcedure，標準作業(yè)程序。以前我們常說，中式菜譜喜歡用“鹽少許、醬油少許、大火煎炸做得不夠。真正的寫作，不是刻意追求辭藻的華麗，而是意思和情境的準確表達。要想寫好技術(shù)文檔，還有一個重要技巧，那就是多用圖表。所謂“字不如表、表不如圖”。技術(shù)是很抽象的東西，也是理解起來很有難度的東西。想要靠純文字進行內(nèi)容轉(zhuǎn)述，是很困難的。所以，應(yīng)該更多地借助表格和圖片，甚至gif動圖，幫助讀者理解。的角度，不能以讀者滿意度為出發(fā)點，那么，就不會愿意多此一舉去畫圖。畫圖是很復(fù)雜的工作，有時候我寫文章，一幅圖都要畫一天，很不容易。是受益匪淺的。人知識沉淀積累。個人可以開技術(shù)blog或公眾號，發(fā)表并分享自己的經(jīng)驗心得，會很有成就感，日積月累的話，甚至可能形成個人品牌和影響力，有利于自己的職業(yè)生涯發(fā)展。頻取代的。目前