软件文档编写

一、软件文档分类

软件项目工作中会接触到很多文档技术文档，比如用户手册、安装操作手册、系统实施部署手册、系统运行维护手册等，这些文档咋看起来会感觉起来都差不多，不用担心目前只需要掌握其中一种。这些文档在后期工作中都会遇到，只要明白文档是针对不同用户来进行编写这条就可以。

1. 软件安装手册（系统安装、配置）

2. 软件用户手册

• 系统管理员手册（系统概述、组织结构、角色权限、系统配置、操作日志）

• 系统用户手册（系统概述、功能介绍、功能操作描述）

3. 系统实施部署手册（目的、术语、部署环境、软硬件安装步骤配置、应用系统安装配置、常见问题）

4. 软件系统运行维护手册（系统运行监控、系统升级管理、系统运行维护记录）

除了上述重要的文档，我们在日常工作中会遇到项目过程文档、每天写的日报及周报，月总结都是属于文档。

二、软件文档编写

1. 为什么写文档

   • 信息共享，个人技术能力沉淀，分享出来解决他人问题。
   • 构建个人知识体系，提高个人解决问题能力。
   • 节省时间成本。文档写好，更多人看懂，看完后操作会快。
   • 记录创造财富。

2. 文档内容写什么

   内容写自己做过的

   内容最好写自己实践过的

   内容一定是自己经历过的

3. 如何写编写文档

   • 收集
   • 梳理
   • 模仿
   • 实践
   • 编写

   举例：找打一个你之前解决的问题记录，再次进行复盘查找资料，按照结构化表达方式，梳理要表达点，参考别人是如何写的（主要是文章框架），模仿写，形成文档。

4. 文档其他要求

• 文档包括

  标题、文本、段落、图片、表格

• 文档编写思维

  流程化：1. 先有什么 2. 后有什么 3. 最后结果
  精细化：逻辑表达、内容组织、排版

• 文档署名及引用

  要是自己创造的写上自己的名字，引用的内容就双引号引上，后面标注出处。

• 文档需不断的更新

三、不得不说

查看了小哥哥们发过来的软件学习过程记录文档，我自己思考我自己开始学这些软件编辑出来的文档跟他们有什么不同？直观感受是他们写的好。

他们提交的这些文档让我思考，这些文档的目的与意义，如何去写好这些文档。

文档编写能力是职业发张的核心技能之一，需要锻炼。锻炼之前得知道怎么去锻炼。从产生这个想法，写一点，收集资料，写一点花了好几个小时，觉得写作能力还是有待提高。

写的过程中确实会不断提醒自己我写的这个目的是什么？让自己让他人会得到什么。当你越问自己这个问题，你会发现你的速度会慢下来，会去重头再去看自己写的。其实内心有一个想法想给小哥哥们一些提示。

进不进步没关系，先培养自己开放心态，相互学习。是我们在相处过程中让我产生了思考，行动，得到结果。

四、参考链接

操作手册与用户手册区别by 李富超

技术文档如何编写？by 谢伟

中文技术文档写作规范 by 阮一峰