寫項目文檔的一些注意要點

 
     1).編寫文檔，是在項目過程中不可避免的一項繁重的體力勞動與腦力勞動相結合的工作.
 
     2).無論是寫操作流程的TXT文本，還是寫標準規範的WORD文檔，絕對是一個體現一個人思維是否縝密，工作是否細心的地方，一手漂亮的、規範的、清晰的工作文檔，絕對可以大幅度提高你在老闆心中的位置。
 
     3).首先，文檔要寫的清晰，規範，體現你對工作業務的熟悉，體現你對項目建設的充分理解；其次，充分體現你對項目正常化的認識，體現一定的管理認識水平，這可是上司考核你的要點，加薪就要靠它了。
 
     4).要任何時候都把寫文檔擺到重要的位置，不要任何時候都隨隨便便的去應付它，除非是寫給自己看的，即使這樣，也要對得起自己的工作。在這方面，就我工作2年來所經曆，我吃虧太多於此了。
   
     5).老調先提：明確你的文檔的目的是要給誰看的，給客戶看所以簡潔易懂最重要，當然正式的標準的文檔必須要有一定數量的專業的詞語來體現你的專業水平，有時候讓人看不懂的，充滿專業詞語的文檔很能體現個人“專業”水平的。

     6).既然是寫文檔的工作，自然是少不料複製黏貼的工作，多搜集整理收藏有用的文檔，多使用baidu，goole一下絕對有莫大的好處，俗話說的好，整合也是一種創新，在整合中融入你對業務的、技術的理解絕對是你一手漂亮寫手水平的前提。

    注意要點：
     1.盡量避免繁冗拖遝的文字敘述，盡量多分章節要點，多使用項目編號
     2.word文檔中，段落與表格的結合，與圖片的結合，txt文檔使用段落與項目編號，都可以使文檔清晰易懂
     3.word文檔要非常注意標準的格式和規範，一般公司都有自己的模板規範，正式本文內容前一定要先檢查格式要點。
 
 下面是一個簡單的寫操作手冊的TXT文檔一部分：

1.右鍵開啟網站管理，點建立網站，在彈出頁面輸入： 
    1).基本資料：
        網站名稱：網站位置輸入“資訊專區”，注意不能重複
        網站描述：網站說明，可不填
        網站HTTP: 可不填
        存放位置: 網站位置輸入“loacl_new”
        發布後的文檔被修改後的狀態:選擇"采編或新稿"
        可發布的文檔狀態:全選
        檔案需要上傳:填選網站發布目的ftp伺服器
    2).計劃發布:可不填
    3).版本配置:全選自動儲存的全部選項
    4).發布檔案名稱:細覽頁面,副檔名填“jsp”


2.開啟測試資訊專區網站範本管理員，將資訊專區概覽和細覽匯出(zip檔案)，並匯入到資訊專區資料的範本管理員中，在該頻道屬性分別設定概覽和細覽，同時選擇繼承父頻道概覽和繼承父頻道細覽，點應用完成所有資訊專區相關頻道概覽細覽設定。

      1).資訊專區細覽20070510 
      2).資訊庫通用細覽20070412 
      3).資訊專區通用概覽
   

3.網站建立後，使用該網站的右鍵菜單建立普通頻道，即資訊總站“資訊專區資料”，存放位置為“km_data”此處需要注意的是，開啟頻道屬性進行如下設定：

    1).發布相關設定:概覽摸板選擇"資訊專區通用概覽",細覽摸板選擇"資訊專區細覽20070510",勾選"重新設定所有子頻道概覽摸板"和"重新設定所有子頻道細覽摸板"
    2).自訂表格單:
        文檔採集模板改為“/wcm/doc/km_post_document.jsp”
        文檔編輯模板改為“/wcm/doc/km_edit_document.jsp”
        文檔列表模板改為“/wcm/doc/km_list_document.jsp”


3.在“資訊專區資料”頻道內建立名稱為“資訊庫”的頻道，存放位置為頻道“store”，顯示名稱與頻道名稱一致，其他可不填,相關設定如下：

    1).發布相關設定:概覽摸板選擇"資訊專區通用概覽",細覽摸板選擇"資訊庫細覽20070510",勾選"繼承父頻道概覽摸板"和"繼承父頻道細覽摸板"
    2).自訂表格單:
        文檔採集模板改為“/wcm/doc/km_store_add_document.jsp”
        文檔編輯模板改為“/wcm/doc/km_edit_document.jsp”
        文檔列表模板改為“/wcm/doc/km_list_document.jsp”


4.同理建立“資訊專區”頻道，存放位置為“zone”，相關設定如下：

    1).發布相關設定:概覽摸板選擇"資訊專區通用概覽",細覽摸板選擇"資訊專區細覽20070510",勾選"繼承父頻道概覽摸板"和"繼承父頻道細覽摸板"
    2).自訂表格單:
        文檔採集模板改為“/wcm/doc/km_post_document.jsp”
        文檔編輯模板改為“/wcm/doc/km_edit_document.jsp”
        文檔列表模板改為“/wcm/doc/km_list_document.jsp”