怎么样的文档才算实用

    1.目的明确，针对性强

        文档肯定是针对某类问题的说明，因此要求目的明确，针对性强。比如若仅是针对某个模块其中一个版本的说明，则决不含糊其辞，而是在很明显的地方与以说明，决不浪费使用者/读者的时间。

    2.条理清晰，可读性强

    从读者角度思考问题，合理编排章节，讲清楚：是什么？为什么？怎么做？等几个问题，必要时还需要增加“谁？”“何时？何地？何种情况？”等一些问题。

    3.前后呼应，一致性好

    在文中多次出现的有关内容，应该前后描述一致，不自相矛盾。

    4.内容充实，实事求是

    就某个问题的描述，应该言之有物而不夸夸其谈，若其中某个部分实在没东西讲，应该写明“内容有待细化/补充”等。

    在文中出现对有关内容的引述，应该尽可能提供链接或出处，方便读者搜索，以便于更深入研究。

    6.操作性强，便于共享

    如果文档的特点是针对操作开展，则应该在内容的真实性、可验证性上做足文章。尽可能地提供可视化的图片或其他媒体方式，以便内容直观，更易于理解，读者能够根据文档的提示一步步完成某项工作。