怎样编写面向受众的网站文档？

一个组织不行能只要高档软件工程师或零碎管理员，以是，只要基于特定例范的文档就象征着只要高档手艺职员才气浏览这些文档。这是一种性能障碍问题。当然，这些文档也是须要和首要的，这曾经比只要浏览代码才气理解应用程序的情况好不少了。然而，这其实不是一种完整的文档策略与文明。
解决要领:编写面向受众的文档

怎样解读一种特定类型的文档取决于个人在组织中的位置。比方，对付零碎管理员而言，api参考文档毫无用场，对高档零碎管理员也样。他们不行能花时间去浏览api参考文档，更不消说让他们注释或运用api参考文档去改良运维过程了。零碎管理员需求的是面向零碎管理员环境编写的文档。这类文档自己能够会包罗不少来自api参考文档的信息，可是这个文档不该该只摆列函数，还应该包罗其余一些信息，如api可以支持几个个要求，它运用甚么网络协定，以及它依赖哪些软件，等等。如许才气协助零碎管理员理解怎样部署应用程序，从而知道应在服务器环境中部署哪些组件。在这类情况下，咱们会先从api参考文档起头，而后给出头具名向两种读者的两个详细的api实现文档:运维指开发指南。

编写面向差别受众的完整文档集，让文档成为一个团队文明的鲜活部分。一定要理解需求运用文档的受众，如营业用户、零碎管理员、数据库管理员、软件开发职员、网络工程师、项目经理，等等。对付营业用户而言，或许api规范需求思索所支持的每种应用的开消本钱；而对付网络工程师来讲，则能够需求注明应用程序运用了哪些协定。应该编写哪种文档，并无一种固定形式，而彻底取决于营业及团队的需求。

益处:强化差别团队之间的纽带

面向差别受众编写文档，其后果一定能够优化人们对付营业双方的理解，削减误会和毛病，而且削减双方的压力。而且，咱们可以在一个文档的根蒂根基上编写另外一个文档。比方，在理解网站制作应用程序及运维根蒂根基架构(服务器、网络设备等)的功用与限定之后，咱们就能够在维护、功用布局本钱及可扩展性指标上运用这些信息。若是一个文档可以行使另外一个文档，那末编写文档的时间就会大大削减。这类体式格局纷歧定合用于一切情况，可是不少时辰都是如许的。