如何编写面向受众的网站文档?
一个组织弗成能只有高等软件工程师或体系治理员,所以,只有基于特定例范的文档就意味着只有高等技巧人员能力浏览这些文档。这是一种机能障碍问题。当然,这些文档也是需要和主要的,这已经比只有浏览代码能力懂得运用法式的情形好许多了。然而,这并不是一种完全的文档计谋与文化。
解决办法:编写面向受众的文档
若何解读一种特定类型的文档取决于小我在组织中的地位。例如,对于体系治理员而言,API参考文档毫无用途,对高等体系治理员也样。他们弗成能花时光去浏览API参考文档,更不消说让他们说明或应用API参考文档去改良运维进程了。体系治理员须要的是面向体系治理员情况编写的文档。这种文档自己可能会包括许多来自API参考文档的信息,然则这个文档不该该只枚举函数,还应当包括其他一些信息,如API可以支撑若干个要求,它应用什么收集协定,以及它依附哪些软件,等等。如许能力赞助体系治理员懂得若何安排运用法式,从而知道应在办事器情况中安排哪些组件。在这种情形下,我们会先从API参考文档开端,然后给出头具名向两种读者的两个具体的API实现文档:运维指南和开辟指南。
编写面向分歧受众的完全文档集,让文档成为一个团队文化的鲜活部门。必定要懂得须要应用文档的受众,如营业用户、体系治理员、数据库治理员、软件开辟人员、收集工程师、项目司理,等等。对于营业用户而言,或许API规范须要斟酌所支撑的每种运用的开销成本;而对于收集工程师来说,则可能须要解释运用法式应用了哪些协定。应当编写哪一种文档,并没有一种固定模式,而完整取决于营业及团队的须要。
利益:强化分歧团队之间的纽带
面向分歧受众编写文档,其成果必定可以或许优化人们对于营业两边的懂得,削减误会和毛病,而且削减两边的压力。并且,我们可以在一个文档的基本上编写另一个文档。例如,在懂得网站扶植运用法式及运维基本架构(办事器、收集装备等)的功效与限制之后,我们就可以在保护、功效计划成本及可扩大性指标上应用这些信息。假如一个文档可以应用另一个文档,那么编写文档的时光就会年夜年夜削减。这种方法纷歧定实用于所有情形,然则许多时刻都是如许的。