推外网络专注营销型网站品牌策划与推广
FOCUS MARKETING WEBSITE BRAND PLANNING AND MARKETING PROMOTION
一个组织不可能只有高级软件工程师或系统管理员,所以,只有基于特定规范的文档就意味着只有高级技术人员才能阅读这些文档。这是一种机能障碍问题。当然,这些文档也是必要和重要的,这已经比只有阅读代码才能了解应用程序的情况好很多了。然而,这并不是一种完整的文档战略与文化。
解决方法:编写面向受众的文档
如何解读一种特定类型的文档取决于个人在组织中的位置。例如,对于系统管理员而言,API参考文档毫无用处,对高级系统管理员也样。他们不可能花时间去阅读API参考文档,更不用说让他们解释或使用API参考文档去改进运维过程了。系统管理员需要的是面向系统管理员环境编写的文档。这种文档本身可能会包含很多来自API参考文档的信息,但是这个文档不应该只罗列函数,还应该包含其他一些信息,如API可以支持多少个请求,它使用什么网络协议,以及它依赖哪些软件,等等。这样才能帮助系统管理员理解如何部署应用程序,从而知道应在服务器环境中部署哪些组件。在这种情况下,我们会先从API参考文档开始,然后给出面向两种读者的两个具体的API实现文档:运维指南和开发指南。
编写面向不同受众的完整文档集,让文档成为一个团队文化的鲜活部分。一定要理解需要使用文档的受众,如业务用户、系统管理员、数据库管理员、软件开发人员、网络工程师、项目经理,等等。对于业务用户而言,或许API规范需要考虑所支持的每种应用的开销成本;而对于网络工程师来说,则可能需要说明应用程序使用了哪些协议。应该编写哪一种文档,并没有一种固定模式,而完全取决于业务及团队的需要。
好处:强化不同团队之间的纽带
面向不同受众编写文档,其结果必然能够优化人们对于业务双方的理解,减少误解和错误,并且减少双方的压力。而且,我们可以在一个文档的基础上编写另一个文档。例如,在了解网站建设应用程序及运维基础架构(服务器、网络设备等)的功能与限制之后,我们就可以在维护、功能规划成本及可扩展性指标上使用这些信息。如果一个文档可以利用另一个文档,那么编写文档的时间就会大大减少。这种方式不一定适用于所有情况,但是很多时候都是这样的。
热门文章
联络方式:
电话:400-026-0708
邮箱:admin@whytui.com
-
震惊!商家被支付宝截图骗20余万,没想到竟让百度做了背锅侠!
骗子年年有,今年特别多。从P2P的庞氏骗局到互联网的各种诈骗,络绎不绝。可以说互联网改变了我们的生活方式,但是也给骗子创造了更多的骗人方式。有人薅羊毛专盯着一
-
SEO优化没有效果应该从哪几个方面分析
搭建自己或企业网站来进行seo推广,是快速通过网络获取精准客户的重要途径,随着SEO逐步向内容生态化方向发展,很多站长开始自己进行SEO优化,但是有些站长优化效果比较
-
如何做好外链
相信很多刚开始接触seo的朋友经常会听到这么一段话:内容为王,外链为后。耳熟吗?这句话很好理解,内容就是网站一个的灵魂,那么外链则是一个网站关键。今天中涛SEO优化师
-
H5响应式网站是什么?
随着搜索引擎技术的不断,同时也为了满足现代用户对体验的追求,H5网站逐步受到很多企业和站长的青睐。这是为什么呢?相比之前的简单企业展示站在seo优化推广中有哪些
-
网站TDK优化时要注意的问题
网站TDK就是在百度对网站进行抓取时告诉它这个页面是干什么的,会让百度对其了解。网站的质量好不好,都是可以通过网站的TDK看出来的,所以TDK的设置也是网站之中较为