文档目的

      编写文档前需要明确文档要达成的目的是什么？搞清出3点：文档阅读对象？背景以及为了达成目标？阅读人习惯等。基于这些前提才可以有针对性的编写文档，不是为了完成写一个文档的任务而编写。举个例子：给市场口领导推销一款产品，理应归类为销售类，领导关注产品能解决什么问题，有什么特性，有何亮点，产品转换价值成功案例。不关注实现原理、技术、业务逻辑。阅读体验上，包括字体、字体大小、格式这些是否有固有的喜爱，这些形式上没有固化的，因人而已。总结起来就是知己知彼，投其所好，预取先予。

编写流程

      文档全什么周期，分为文档准备、文档构思、文档编写、文档审核、文档发布。

        文档准备工作，了解目标对象，准备编写内容素材，包括行业、产品、技术等。

        文档构思，有成熟模板可以在模板框架下进行展开内容构想，没有模板下还需构想文档架构，理解为文档目录。

        文档编写，按文档既定目录进行内容撰写，完成初稿，再完善修改。遵守”黄金四法则“

      1、主题明确单一

      2、内容通俗易懂

      3、图表优于文字

      4、例子利于理解

      文档审查，先自审在对外发布，重要文档需要发起文档审查或文档测试，审查和测试有一套验证标准，依据标准逐个校验。

      文档发布，通过合适渠道发布给目标对象，文档如有变动及时更新。

关注点

    文档一致性

      主题一致性，要传达信息是紧紧围绕文档目的的，不偏题跑题，比如：需求说明书，描述需要什么，概要设计，描述做哪些事，详细设计，描述具体怎么实现。

      术语一致性，一个概念在文档出现多次，要保持一致性不要让阅读者思考其中的差异区别，举个例子：应用系统可以快速解决XX问题，应用管理系统应该具备功能XX。应用系统和应用管理系统，是同一个概念，但文档中描述不一样，给人造成了困惑，带来误解。

      格式一致，包括字体一致、字体大小一致、标题格式一致，段落一致、图位置一致、表位置一致

      对象一致，针对对象描述问题方式，特别是操作指引文档，阅读的水平定义在哪个层面？是需要每一个步骤都描述操作详情，还是告知要做一个什么事情。确定了以后，文档要始终如一的贯穿，不要出现有的地方描述详细，按照文档可以指导完成工作，有的地方一笔带过，这样无形增加了障碍，我要怎么做？自己摸索还是找相应的服务人员？产品如果是到最终用户手上，体验大打折扣，公司形象及品牌度受影响，售后压力工作量增加，间接增加了公司成本。如果是内部人员使用，增加了沟通成本，影响产品落地周期，直接增加了公司成本。

      描述一致性，任务性描述，动词+名词；概念描述，名词+动词。

    易懂性

      “奥卡姆剃刀原理”无需必要，勿增实体。言简意赅，简单明了。需要避免使用摸棱两可词语词语，示例：基本、可能；介词，示例：比如、首先、然后、再；个人色彩词语，举例：我觉得、我建议、喜欢等等。尽量使用描述性语句。

    易读性

      文档前后连贯，逻辑性强。文档需要使用目录、索引，避免内容重复描述文档内容可链接引用。对术语、缩写进行说明，避免阅读时猜测，费时耗力，甚至误解。对于重点内容突出标记、危险警告说明、难点提示，以引起读者的重视。出现图表地方对图表都有描述，不要无端端的出现一个孤立的图表。目录上放上图目录和表目录；

    舒适性

      舒适性第一个感觉就是文档看着很爽，简单大方得体，描绘的是一幅优美的画面。

      段落尽量不超过400字，一句话尽量不超过100字。对一些内容过长的，有先后顺序的有有序符号排序，无先后顺序的用无序符合编排。例如：有序的实施步骤，按顺序1、2、3依次操作。无序的机器配置，按CPU、内存、磁盘依次编排，不用挤在一样描述。图片清晰，图片里面的字体大小合适