在推出Altium Designer 14的同时,Altium正式宣布公司技术文档的“新家” - techdocs.altium.com即将投入使用。
这是Altium重要的里程碑之一,同时也标志着Atium文档整合项目的正式启动,然后是更多地文档更新!这也正在实践着我们的郑重承诺——提供高关联度、高可访问性和优质的文档,旨在帮助我们的客户更优化地使用我们的设计解决方案。
作为一名多年来编著多篇Altium技术文档的“沙场老将”,我感到,全新文档平台又为我赋予了新的力量。不仅我和我的同事,所有读者都会在这个全新文档平台上受益匪浅。
因此,请与我携手见证Altium技术文档的新纪元。通过这篇博文,我向各位解释这个新网站的内容以及未来的发展方向,同时我还会透露一些小小的“内幕”,关于这个网站的现有状况以及未来的发展步骤。
并非“维基百科”
在您白我一眼然后离开之前,我希望再次强调,它绝不是“维基百科”! 我深知“维基百科”一词在这些年来给我们的读者带来多大的挫折感。某一天,我在完成了一天PDF文档生成工作后,晚上11点离开办公室,可当我第二天发现维基百科变得面目全非,我的反应您可想而知!
维基百科被定义为汇聚大量各类投稿人发布主题文档的基地。而Altium的文档主题是限定的,此类主题文档该由Altium团队成员编制与提供。将这一负担添加给我们的用户是不切实际的。
尽管我们起步较晚,但是我们确信Altium提供的文档平台应该是一个高端内容受控的管理系统,而不是由Altium用户社区的共享文档组成的区域。
我们已经有了相应的平台资源,于是我们首先更新了Altium的网站,然后构建了基于开放源码的Drupal内容管理系统。
文档的统一交付
过去,获取文档的障碍在于“理解”文档。一会是几篇维基百科的文章、一会是几个PDF文件、一会又是几个陈旧风格的WinHelp与HTML帮助文件,这种“拼凑式”的文档组织简直是让人无所适从。这种奇葩的文档管理真的给我们一体化设计软件抹黑!
techdocs网站提供了一个统一的浏览环境,在这里能够查找到所有文档——从有关新版本功能的高级别概念文档,到解释对话框的作用或者命令使用方式的低级别资源文档。
此外,通过使用Drupal平台,我们能够将文档与AltiumLive社区完全整合起来。普通读者无需注册,如果想参与反馈意见的读者,也无须重新进行登录,只要使用您的用户名与密码登录一次AltiumLive即可。
第一步...
我们的文档资源可以追溯到公司开发99 SE的时候。现在它们已经变成了文档的海洋!但这是一把“双刃剑”——编写的内容越多,需要维护的内容也越多。而面对我们所肩负的浩大艰巨的任务,我们没有选择的余地。
但千里之行始于足下。我能骄傲的证明我们的决心和信心,一群快乐的文档作者们已经开始执行这项任务。他们把精力主要地集中在核心技术的资源的整理上(即原理图与PCB图)。我将与各位分享网站首次发布时的一些统计数据:
- 394个对话框。
- 1541个指令
- 52个参数选择页面
- 57个对象
- 13个面板
- 28 条设计规则
此外,新网站中还包含大量“新鲜出炉”的、详细介绍Altium Designer 14新功能特性的文章!
基于浏览器的对话框帮助功能
您理解的没错!我们摒弃了过时的帮助方法和技术,而是通过统一的Techdocs网站提供所有文档。在对话框帮助方面,您不再需要通过反复的点击来零碎地查看帮助选项。只需按下F1,对话框便会自动打开,获取一整页相关的信息——各个选项与控件的作用一目了然。在浏览器页面上显示信息能够带来诸多好处,远远超过WinHelp,它们包括:
- 能够凭借额外的注释、信息与加亮提示框,详细阐述具体的操作。
- 能够在点击对话框的其他位置仍然保持信息可见。
- 能够交叉链接相关的技术文档,不仅包括技术文档而且包含更广泛的AltiumLive社区。
- 能够以更为简化、快捷的方式维护对话相关文档——无须汇编安装文件即可更新。
这个首发的版本中提供了支持Altium Designer F1帮助功能的大量资源。尽管您可能还会遇到跳不出特定页面的情况,但我们会很快修复的!
易于浏览
在软件中直接访问帮助资料不是唯一的方法。对于喜欢使用导航树和搜索功能浏览文档的用户,我们也提供了相应的方法。
首先,所有的内容已经被划分到更明确、更专业的区域。这种更实用的页面分组会为您带来更合理的浏览体验,并帮助您更快的找到您所需要的信息。
此外,平台自带的搜索功能也能从这种分区方法中受益,您可以从所有区域中查找文档,也可以在当前区域内查找文档。
前方的路
在任何旅程中,都很难预计每段行程将花费多少时间,路途中会遇到什么障碍,或是下个拐角将遇到什么事件。然而,凭借全新而强大的内容管理平台、来自Drupal专家的支持以及不断扩大的文档作者团队,我们已开始制定一个决定性的计划,并且在未来几个发布版本中实现目标。为了吸引您的眼球,我罗列了以下一些新平台即将实现的亮点(当然,排名不分先后)。
离线文档
由于我们使用开源平台管理我们的技术文档,我们已经计划研发本地使用的文档库,而无须支付许可费。这将使您能够选择拥有无需连接互联网的离线文档。而且能够实现重新连接到技术文档“航母”,与AltiumLive“主”文档库同步。
内容质量
尽管这次首次发布中包含了大量的资源参考资料,但这只是冰山一角。这些资料中大部分是Altium Designer高级应用的内容,超过700页的材料,不过有些资料已经过期很久了!
在提供新功能资料的同时,我们还要不断地更新这些过期的资料,这非常费时,但是为了您-我们尊贵的用户的信任,这是非常重要的。
参考资料
在初次发布的版本中,我们提供了大量资源素材,毋庸置疑,我们将在今后延续这一良好势头。尽快发布剩余的相关核心技术资源,随后是服务器相关的辅助技术资料。请不要忘记,大量的详细参考也需要彻底检查!
高级语义搜索
尽管提供了文档的搜索功能,但从本质上而言,目前的搜索只能算是基础搜索。为了我们的用户可以得到更可靠的结果,我们需要进一步加强这个基础的搜索引擎并且彻底地改变它。通过使用标签与索引来加强搜索引擎,从而实现高级搜索,它不仅支持搜索技术文档,还能搜索AltiumLive社区乃至整个Altium网站的所有资源。
提升生产率
通过引入诸如注释与共享等功能特性,您将能够组建可以在团队中共享的“文档组”。您将能够编制具有特色的文档,并与他人分享,“便签夹”的功能会提升到一个全新的水平!
语言支持
多年来,许多人问我为何无法实现支持不同的语言。这是个好问题!网站中有一些不同语言的区域,但它们的内容与并不是完全模仿英语区域。但我们要强调的是,比起作者在这些领域内的贡献,我们的编辑工具还需要有很长的路要走。但如今,凭借我们的Drupal(文档管理)平台,我们能够重新激活整个区域。
对我们而言,提供多语言支持的技术文档是我们全球运营战略不可或缺的重要组成部分,在未来我们也将一如既往地秉承这个战略目标。
敬请期待
我真心希望这篇博文能够在某些方面真正消除您的疑虑,并帮助您了解,我们始终致力于有效诠释我们的文档,在我们值得信赖的软件平台的支持下,为您提供完整的原汁原味的技术文档库。
因此,尽管我们在编制资源文档和提供更为广泛的文档组方面任重而道远,但我想说的是,敬请期待我们的表现。这只是完全准确覆盖软件特性与功能的第一步。这也是我们坚信能够实现的长期目标!