维护文档写作注意事项

• 写作目的：使维护人员通过该手册能够正确对系统进行维护，在维护中，尽可能的不要走弯        路，不要因为某些操作失误而导致重新操作，这些注意事项都需要表达清楚，整个文档应该描述清楚。不能有模棱两可的地方。

• 写作方法：考虑该模块与其它模块之间的关系（涉及到写作的顺序，写作的配合），尽可能的是一个子模块（该子模块涉及到多个功能点，而这些功能点之间是有依赖关系的）的写作，由同一个人完成。
•           
• 考虑该模块的内部要求，可以参考模块规格设计。从中选择部分语句（主要是一些对用户进行现则性的语句，例如：注意后的一些信息）进行提炼后置于此处

         

• 尽可能的考虑到用户在操作某一步骤时，会出现哪些错误，应该怎么规避。例如：文件名必须以***结尾

         

• 区分管理人员与维护人员之间的差异性，认真体会这些人员的要求，即从用户的角度来思考问题

        

• 图片不宜过多过大，这不是安装手册。

         

• 比较复杂的事例，可以通过举例来进行描述

         

• 最好是由开发人员与用户进行结对写该文档

         

• 在涉及到用户名的地方，最好使用“张三”、“李四”来代替，而不是使用“yanliebing”这样的用户名

         

• 在涉及到上下级用户（部门等）、需要说明此处是直属上级用户还是所有上级用户

         
          在每一次文档评审后，都需要总结，否则很容易忘记。而且自己需要理解该文档在整个系统中的作用。 思考

暂时想到这么多了！！！
         

分享到：

可伸缩性最佳实践 | 读取ar包中所有属性文件值

• 2009-04-23 14:10
• 浏览 925
• 评论(0)
• 查看更多