新疆软件开发

本站首页 软件开发 成功案例 公司新闻 公司简介 客服中心 软件技术 网站建设
  您现在的位置: 大发国际老虎机官网 >> 公司新闻

软件文档写作注意点

不需要把问题的来龙去脉写的很清楚,也就是不需要起因、发展、情节;
专业术语必须有解释部分;
尽量使用短句;
对文档做好章节编排,编制好章节号;
章节名称必须能够概括本章节的主要内容,以便按章节名称查找信息;
注意文档定义的读者,考虑读者对于文档相关内容的必须背景的了解;

文档必须及时更新,以确保内容不是错误的,与当前的实际相符合;
 
注意:软件文档是应用文的一种,需要有应用文的特点:
1、特定的对象和写作目的
2、有较为固定的写作格式
3、有较强的时效性;
4、语言要朴实、简明、准确
 
另外并不是每个人的行文能力都达到了写出好文档的水平,但是都是可以培养的,更何况软件文档有固定的格式。

作者:丑石 | 文章来源:csai.cn | 更新时间:2007-10-20 11:55:16

  • 上一篇文章:

  • 下一篇文章:

  • 相关文章:
    没有相关文章
    公司简介
    · 公司简介
    · 公司新闻
    · 成功案例
    · 联系我们
    · 客服中心
    最新新闻
    ·新疆二域提供新疆手机APP开
    ·微信公众平台开发业务
    ·智能停车场管理系统方案
    ·固定资产管理系统功能说明
    ·新疆乌鲁木齐防盗门生产管
    ·合同管理系统功能简介
    ·二域公司春节放假通知
    ·新疆二域软件车队车辆管理
    关于我们 | 软件开发 | 下载试用 | 客服中心 | 联系我们 | 友情链接 | 网站地图 | 新疆电子地图 | RSS订阅
    版权所有 © 2016 大发国际老虎机官网 www.k8w.net All Rights Reserved 新ICP备14003571号
    新疆软件开发总机:0991-4842803、4811639.
    客服QQ:596589785 ;地址:新疆乌鲁木齐北京中路华联大厦A-5C 邮编:830000