Single-sourcing文档开发的误区

2010年 三月 7日
by Chuancy

名词解释:Single-sourcing,比较难找到短的中文对等词,暂且翻译为“同源多格式”文档发布方法,是指能让你只维护同一堆文档内容即可实现向多种格式输出的文档编辑和开发方法。

Michael Hiatt的博客文章The Myth of Single-Source Authoring对90年代开始兴起的、基于XML规范的single-sourcing(同源多格式)文档开发模式提出了挑战。他拿“社会化”网络应用(Web2.0模式)、基于“云”端的内容聚合器(content mashup)等新兴的知识产生模式来支持他的挑战。

采用XML规范实现编写文档源的工具(例如:DocBook XML、DITA等)来实现的同源多格式文档开发模式究竟是否已过时?我看未必,要看你是否把它用在了正确的文档开发任务。

每种工具都有设计的初衷和想解决的问题。Michael对XML工具公认的一些优势和价值提出了挑战,这里我只对那些我本人有实际经验的观点发表看法:

1. 发布为多种格式

Michael认为:现代很多流行的文档编辑工具都可以做到编辑一次,发布为多种格式,对高度结构化、可发布为HTML、PDF等多种格式的文档内容的需求在90年代就已经消亡。

我的看法:Michael所提的均为事实,但实际上生产环境中需要的不仅仅是多种格式的输出能力,而且实际生产环境中使用某种single-sourcing文档工具的动机不单单是多格式输出。

2. 内容的重用

Michael认为:文本写作内容重用很难和代码的重用相提并论:代码是给计算机/机器去解读的而且根据十分严密的语法和技巧(例如面向对象技巧)来实现代码重用,但文本内容的重用建立在类似的基础是错的——因为文本内容是依赖人脑去解读,从作者的脑袋流向读者的脑袋,而人脑解读信息是十分直观的而且很容易误读。

我的看法:的确,无论你安排的文档最小主题多么合理,你很难100%复制到新的版本去使用。但这个过程本身比重新写要省事,“内容重用”的编辑技巧的最大价值是为了节省开发新版本的时间,这点特性对每天要面对海量文本编辑工作的技术作者而言尤其重要。

3. 信任其他人(其它作者)

Michael对这个问题的质疑的基础是:一个作者很少会完全重用其他作者写过的主题/内容。因为每一个写作任务的上下文都是不可能完全相同的。重用和完全信任其他作者的方法一般是局限在机构内部合作一起写一本书,但是要在整个企业范围内实现文档内容重用就很少有成功的。

我的看法:同意。

4. 公司内部(闭门)写作

Michael认为用户对产品的信息来源不仅仅是公司内部发布的官方文档,还包括诸多社会化网络应用:博客、聚合器、社区网站等。公司内部雇佣的作者需要和这些外部的信息和知识来源竞争,少数作者的智能很难和来源于世界各地的博客写手(领域专家)等相比的。

我的看法:“闭门写作”和依赖社会化应用软件(例如开放的Wiki等)协同编写文档是相符相成的,不同的方式适用于产品开发、应用的不同阶段,它们并不矛盾也不存在“竞争”关系。“闭门写作”能确保产品文档的基本质量、完整性,且能让开发经理掌控其进度并实现按时与产品一起交付。依赖社会化网络来获得各方面的产品知识的反馈和输入(input)则是可以贯穿产品文档的整个生命周期的做法。只要企业认为有必要而且能有资源投入,随时可以实现社会化网络的产品知识形成和文档内部开发之间的融合。

结束语:

任何技术/产品与新的可替代技术/产品之间的关系不完全是竞争的关系。厂家和消费者真正能获益的方法并不是去选新的而放弃旧的,而是如何去根据企业/用户的实际情况自由组合/融合这些新的和旧的技术/产品/方法,以争取最大的效益。

W3C官方网站重新设计

2009年 十二月 19日
tags: , ,
by Chuancy

http://www.w3.org/standards/

互联网简史

2009年 十一月 19日
by Chuancy


互联网简史

如果您在阅读此本文,很有可能您一般也花费不少时间上网。但是,既然互联网对我们日常生活的影响是那么深入,我们当中究竟有多少人真正知道互联网是如何起源的呢?

本帖将介绍互联网的简要历史,包括重要的日期,任务,项目,网站,其它能至少帮助你理解这个叫“互联网”东西真正是什么以及它的起源。

当然,互联网的完整历史可以长到能写一本书,本文只向你介绍互联网发展历史上的一些关键里程碑,以及1969年到2009年之间发生的那些影响了互联网的发展和演进的事件。

If you’re reading this article, it’s likely that you spend a fair amount of time online. However, considering how much of an influence the Internet has in our daily lives, how many of us actually know the story of how it got its start?
Here’s a brief history of the Internet, including important dates, people, projects, sites, and other information that should give you at least a partial picture of what this thing we call the Internet really is, and where it came from.
While the complete history of the Internet could easily fill a few books, this article should familiarize you with key milestones and events related to the growth and evolution of the Internet between 1969 to 2009.

阅读英文全文

编写优秀的文档:技术文档风格

2009年 十一月 19日

Python软件框架Django的作者Jacob Kaplan-Moss接上一篇“技术文档:写什么”帖子,继续探讨如何培养能帮你写出优秀的技术文档的写作风格。

Learn to write
Unfortunately, there aren’t any shortcuts here. The best way to learn how to write great documentation is to first learn how to write (anything). There are some important differences between technical documentation and your average prose, but a solid foundation of good written communication skills is an irreplaceable prerequisite.
So how do you learn to write (anything) well? There’s only one answer: you’ll learn to write well if you write. A lot.

学习写作

很不幸,写作没有任何捷径可走。学习如何编写优秀的文档的最好方法首先就是学习如何写作(写任何内容)。技术文档和你平时普通的写作主题有一些重要的区别,但是,书面沟通技能方面的坚实基础是不可替代的前提条件。

那么,怎样才能学会如何写作(写任何内容)呢?答案只有一个:如果要让自己变得能写,你就是要不断地写,大量地写。

英文原文

关于编写优秀的文档(第二部分):你需要一位编辑

2009年 十一月 14日
by Chuancy

Python的框架工具Django的作者Jacob Kaplan-Moss继续写关于文档对开源技术项目的重要性的帖子,这是第二部分:

我应该成为写作专家,对吗?那么为啥我以前发的帖子有那么错误

答案很简单:我的博客没有请编辑。

阅读全文…

关于编写优秀的文档:写什么?

2009年 十一月 11日
by Chuancy

Django框架作者Jacob Kaplan-Moss写了一篇帖子,介绍为何编写好的文档很重要:

我喜欢Django文档。打印出来它刚好700页,大部分的内容很清晰,简洁而且很有用。我认为Django是文档写得最好的开源项目之一,我对此感到最自豪。

阅读全文…

24%的推特消息用软件(机器人)自动发的

2009年 十一月 1日
by Chuancy

根据最近的一份调查报告,24%的推特消息是通过(软件)自动机器人,而不是真人,来发送的。同时,此报告还发现:5%的推特帐号发出的消息占了推特消息总数的75%。

来源/阅读更多:Twitter Zombies: 24% of Tweets Created by Bots

“少就是多”

2009年 十一月 1日
评论关闭
by Chuancy

“换句话说,一个软件的功能虽然有些但如果使用方便的话,此软件通常比同类功能多但更难用的软件要好。”

来源:《经济学家》文章 When Less is More

中国的互联网:为何跟风者能赢

2009年 十月 29日
by Chuancy

乍一看,李松那些典型的中国网络企业家没啥区别。他属于那种懂得不断抄袭美国网站,并希望能通过中国这个全球最大的互联网消费者市场像变魔术一样地建立一个成功企业。毕竟,他已通过投资ChinaHR——一个求职网站并以2亿美元的两笔交易卖给(美国的)Monster.com而赚了不少钱。目前他正经营着Digu.com(嘀咕),一个Twitter(推特)的复制品,以及Zhenai.com,一个也许会成为中国的Match.com的交友约会网站。

来源/阅读更多:techcrunch.com英文原文

更安全的新一代网络浏览器

2009年 九月 10日
by Chuancy

[转自IEEE Spectrum技术简报]

谷歌Chrome,Opus Palladianum和Gazelle网络浏览器将更安全,因为它们的功能设计借鉴了(计算机)操作系统的设计。

英文原文:New-Breed Browsers Are Harder to Hack