還不快點登入,你們這些看小說都不登入就離開的。
登入可以幫助你收藏跟紀錄愛書,大叔的心血要多來支持。
不然管理員會難過。
《通信人的10年沉浮》第21章 如何寫出優秀的技術文檔(上)
  文檔,不管是對於員工個人,還是對於企業,都有非常重要的意義。對於技術類公司來說,技術文檔的重要性更是不言而喻。它的價值,完全可以等同於產品本身。或者說,技術文檔就是產品的一個重要組成部分。

  很多人認為文檔是產品的附屬品,是例行公事的印刷品,這顯然是不對的。

  文檔的根本性質,是貫穿產品生命周期的沉澱積累輸出物,是信息傳遞的重要工具和載體。不同階段的文檔,有不同的作用。不同的崗位,有不同的文檔體系。

  在產品設計和研發階段,有產品設計指導書、產品功能需求說明書等。在產品工程交付階段,有版本發布說明、技術指導書、升級/割接/擴容指導書等。

  文檔還分為內部文檔和外部文檔。內部文檔服務於內部用戶,外部文檔服務於客戶、合作方等外部用戶。內外部文檔密級不同,內容會有所刪減,表述方式和側重點也會有所不同。

  文檔用於指導實際工作。文檔質量的好壞,會影響信息傳遞的準確性和效率,進而影響工作的完成、項目的交付。

  例如,產品開通文檔太爛,客戶看不懂,合作方員工看不懂,甚至自己的工程師也看不懂,就無法依照文檔成功完成設備開通或升級割接。文檔如果出現錯誤,甚至可能造成嚴重的事故。

  現在市場競爭越來越激烈。有時候,雖然產品本身做得很好,價格也很有優勢,但是文檔太爛,一樣會被客戶鄙視,進而拉低了產品的整體競爭力。有損公司品牌形象。

  那麽,決定產品文檔質量的基本要素是什麽呢?

  有人說,是作者的寫作水平。也有人說,是是否有充足的時間。

  其實都不對,基本要素只有一個,那就是錢。

  文檔寫作是一個需要投入大量資源的工作。

  首先,需要建立一個完善的文檔管理體系,包括文檔架構體系,文檔職責歸屬,文檔立項、開發、評審、發布、歸檔流程以及對應平台等。

  其次,需要安排大量的專任或兼任崗位跟進相關流程管理,佔用工時。

  再有,文檔和產品開發一樣,是一個滾動性流程,需要不斷更新迭代。所以,資源投入也是持續性的。

  早期的時候,國內很多企業利用人力成本優勢,發起人海戰術,將資源集中投入到產品研發上,靠價格優勢和版本速度(需求響應速度)搶佔市場。

  開發工程師忙著寫代碼,做版本,哪有時間去寫文檔?基本上都是拿產品設計指導書改一改,截截圖,就扔給了售後,甚至扔給了客戶。

  內部用戶(售後)罵娘,領導其實心裡有數,畢竟資源有限,只能犧牲文檔保版本,對內部反饋進行彈壓。而外部客戶的意見,是無法進行彈壓的。

  對於一些低端客戶來說,比較關注的是價格。極端的成本優勢,可以讓客戶忽視文檔。但是,對於高端用戶來說,他們對文檔的要求和對產品的要求是一致的。沒有優秀齊套的文檔,一樣不給中標。

  於是,倒逼設備商投入資源補齊短板,組織人力進行文檔專項開發。結果發現,其實並不是寫不出好文檔,而是之前沒有舍得投入資源。

  然而,一旦項目應付過去,資源又會撤走,好不容易建立起來的文檔質量,又再次垮塌,如此惡性循環。

  所以說,對於企業,想要把文檔滿意度搞好,樹立有利於產品品牌的文檔品牌形象,關鍵在於領導願不願意投錢。有錢就有人有資源,這是搞好文檔的基本前提。

  隨著市場的規范和成熟,加上競爭日趨激烈,文檔的重要性不斷提升,越來越多的企業負責人開始意識到這個問題,不斷加大對文檔的資源投入。

  戰略層面的重視是基礎,戰術層面的執行是關鍵。
鍵盤左右鍵 ← → 可以切換章節
章節問題回報:
翻譯有問題
章節內容不符
章節內容空白
章節內容殘缺
上下章節連動錯誤
小說很久沒更新了
章節顯示『本章節內容更新中』
其他訊息