Menu
帮助中心

帮助中心

专注网站建设10年,已为2000家公司提供网站建设
您当前所在位置:首页 > > 信息中心 > 帮助中心

怎么编辑网站的新闻文档内容

一个组织不可能只有高级软件工程师或系统管理员,所以,只有基于特定规范的文档就意味着只有高级技术人员才能阅读这些文档。这是一种机能障碍问题。当然,这些文档也是必要和重要的,这已经比只有阅读代码才能了解应用程序的情况好很多了。然而,这并不是一种完整的文档战略与文化。

怎么编辑网站的新闻文档内容



解决方法:编写面向受众的文档
 
  如何解读一种特定类型的文档取决于个人在组织中的位置。例如,对于系统管理员而言,API参考文档毫无用处,对高级系统管理员也样。他们不可能花时间去阅读API参考文档,更不用说让他们解释或使用API参考文档去改进运维过程了。系统管理员需要的是面向系统管理员环境编写的文档。这种文档本身可能会包含很多来自API参考文档的信息,但是这个文档不应该只罗列函数,还应该包含其他一些信息,如API可以支持多少个请求,它使用什么网络协议,以及它依赖哪些软件,等等。这样才能帮助系统管理员理解如何部署应用程序,从而知道应在服务器环境中部署哪些组件。在这种情况下,我们会先从API参考文档开始,然后给出面向两种读者的两个具体的API实现文档:运维指南和开发指南。
 
  编写面向不同受众的完整文档集,让文档成为一个团队文化的鲜活部分。一定要理解需要使用文档的受众,如业务用户、系统管理员、数据库管理员、软件开发人员、网络工程师、项目经理,等等。对于业务用户而言,或许API规范需要考虑所支持的每种应用的开销成本;而对于网络工程师来说,则可能需要说明应用程序使用了哪些协议。应该编写哪一种文档,并没有一种固定模式,而完全取决于业务及团队的需要。
 
好处:强化不同团队之间的纽带
 
面向不同受众编写文档,其结果必然能够优化人们对于业务双方的理解,减少误解和错误,并且减少双方的压力。而且,我们可以在一个文档的基础上编写另一个文档。例如,在了解网站建设应用程序及运维基础架构(服务器、网络设备等)的功能与限制之后,我们就可以在维护、功能规划成本及可扩展性指标上使用这些信息。如果一个文档可以利用另一个文档,那么编写文档的时间就会大大减少。这种方式不一定适用于所有情况,但是很多时候都是这样的。

相关阅读

汇总搜索引擎网站的免费提…

帮助中心 2009-11-15
1,Google免费网站提交入口http://www.google.com/addurl/2,百度免费网站提交入口http://www.baidu.com/se…阅读新闻

网站建设分为几个步骤?

帮助中心 2009-11-01
1.域名注册域名,是互联网上的一个企业或机构的名字,是在互联网上企业间相互联络的网络地址。一个企业如…阅读新闻

网站能干什么?

帮助中心 2009-11-01
例如一个企业在互联网上发布公司简介、新产品信息、产品说明、宣传公司服务、招聘人才等多方面信息。不仅可…阅读新闻

谷歌关闭三个工程办公室 全…

帮助中心 2009-11-01
谷歌周三表示,该公司将关闭三个工程办公室,并在全球范围内裁减约100名员工。据国外媒体报道,谷歌人力资源…阅读新闻

企业域名保护有必要吗?需…

帮助中心 2019-03-30
最近有客户经常接到电话说有人要他们进行互联网保护。互联网保护是什么?从未听说过。实际上就什么域名,中…阅读新闻

网站的ICP经营许可证是什么…

帮助中心 2019-03-30
通常说网站有ICP经营许可证,网站实际上有很多各类的备案,今天沛宣网络先来先来说说网站的ICP经营许可证是…阅读新闻
返回全部新闻

最新发布

河北企业网络营销知识要点…

河北网站建设价格 2019-03-30
在互联网时代,人们可以通过网络获取到各种各样的信息,企业也可以通过网络,将自己的产品和品牌推送到消费…阅读新闻

河北网站建设如何提升自己…

河北网站建设价格 2019-03-30
河北网站建设找沛宣网络在信息化日益爆炸的今天,怎么样才能把一个网站优化通过网络的方式提高它的自然排名…阅读新闻

企业域名保护有必要吗?需…

帮助中心 2019-03-30
最近有客户经常接到电话说有人要他们进行互联网保护。互联网保护是什么?从未听说过。实际上就什么域名,中…阅读新闻

企业网站建设解决方案

解决方案 2019-03-30
第一章:企业网站建设的必要性几乎所有的企业都需要有自己的网络宣传窗口、有一个对外的宣传名片,更多的是…阅读新闻

物流公司网站建设解决方案…

解决方案 2019-03-30
物流公司网站主要以宣传展示为主要功能,体现公司实力,提升公司的价值和品牌知名度。网站以大气,现代化,…阅读新闻

软文:营销型网站建设推荐…

网站建设中心 2019-03-30
品牌营销型网站建设---你渴望的正是我们在做的沛宣网络为您制作一个优秀的营销型网站一个24小时自动工作的超…阅读新闻

手机网站建设必须要注意的…

网站建设中心 2019-03-30
手机网站越来越成为PC电脑网站的标配了,以后也越来越重要,哪么在制作手机网站的时候需要注意哪些方面呢?…阅读新闻

网站的ICP经营许可证是什么…

帮助中心 2019-03-30
通常说网站有ICP经营许可证,网站实际上有很多各类的备案,今天沛宣网络先来先来说说网站的ICP经营许可证是…阅读新闻

怎样使网站符合本地的特色…

行业新闻 2019-03-29
从商业的角度来看,当你决定创建和维护一个多语言网站,必须考虑更多的点不仅仅是翻译。我们将探讨的一些问题…阅读新闻

做网站的时候哪些地方是需…

帮助中心 2019-03-29
做网站的时候哪些功能或者说哪些地方是需要花费用的地方呢?网站建设的价格的不同之处在哪里呢?下面沛宣网…阅读新闻

网站建设知识之优秀的企业…

行业新闻 2019-03-29
俗话说:“授之以鱼不如授之以渔”在信息高速发展的时代,网站建设也得到了快速的发展,企业通过网站来宣传…阅读新闻

您的网站运行速度流畅吗

行业新闻 2019-03-29
说起网站的流畅度,大家肯定想到的是网站的浏览速度,笔者想告诉大家的也正是这一点,如今的网站都为了美化…阅读新闻
返回全部新闻
友情链接:
  • 企业网站建设
  • 营销型网站建设
  • 手机网站建设
  • 模板网站建设
  • H5网站建设
  • 网站改版升级
  • 重庆网站建设
  • 模板网站建设
  • 公司简介
  • 成功案例
  • 解决方案
  • 新闻中心
  • 联系我们
  • 网站地图
  • XML
  • 万州网站建设
  • 江津网站建设
  • 永川网站建设
  • 合川网站建设
  • 北碚网站建设
  • 黔江网站建设
  • 涪陵网站建设
  • 南川网站建设
  • 铜梁网站建设
  • 璧山网站建设
  • 大足网站建设
  • 綦江网站建设
  • 长寿网站建设
  • 开州网站建设
  • 潼南网站建设
  • 武隆网站建设
  • 奉节网站建设
  • 荣昌网站建设
  • 梁平网站建设
  • 城口网站建设
  • 云阳网站建设
  • 巫山网站建设
  • 丰都网站建设
  • 垫江网站建设
  • 秀山网站建设
  • 酉阳网站建设
  • 忠县网站建设
  • 石柱网站建设
  • 彭水网站建设
  • 巫溪网站建设
  • 万盛网站建设
  • 巴南网站建设
  • 江北网站建设
  • 南坪网站建设
  • 九龙坡网站建设
  • 沙坪坝网站建设
  • 大渡口网站建设
  • 毕节网站建设
  • 安顺网站建设
  • 六盘水网站建设
  • 铜仁网站建设
  • 黔东南网站建设
  • 黔南网站建设
  • 黔西南网站建设
  • 遵义网站建设
  • 昆明网站建设
  • 曲靖网站建设
  • 昭通网站建设
  • 绵阳网站建设
  • 自贡网站建设
  • 攀枝花网站建设
  • 玉溪网站建设
  • 保山网站建设
  • 丽江网站建设
  • 临沧网站建设
  • 大理网站建设
  • 普洱网站建设
  • 拉萨网站建设
  • 日喀则网站建设
  • 昌都网站建设
  • 林芝网站建设
  • 山南网站建设
  • 那曲网站建设
  • 阿里网站建设
  • 宝鸡网站建设
  • 汉中网站建设
  • 铜川网站建设
  • 咸阳网站建设
  • 渭南网站建设
  • 安康网站建设
  • 延安网站建设
  • 商洛网站建设
  • 榆林网站建设
  • Copyright © 2008-2018 沛宣网络 渝ICP备13000588号-5 工商备:500108000067794 渝公网安备 50010802002673号

    扫描二维码添加微信:沛宣网络
    确 认