写项目文档的一些注意要点

 
     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”