当你听到这个词文档,如果第一个形象出现在您的脑海是刚才扔掉的肮脏的用户指南,你会有一个惊喜。约翰•格里菲思的亚历克斯·莱特Tod莱维特和Leo Obrst文档是不可或缺的业务资产,降低了软件的成本,极大地改善了用户体验。如果您是一名开发人员,使你成为一个优秀的祖先。编辑器

作者:亚历克斯·莱特约翰•格里菲思托托莱维特,狮子座Obrst

通过文档依赖志愿者和代码开发者,文档更新落后于不断发展的系统软件。重大发展变化的系统,现有的文档变得过时,其值显著降低。勇敢,努力保持当前的文档证明太难改变系统有时有深远的影响在整个文档页面。系统集成和优化快速呈现为开发人员文档过时了。成为了替代和源文档的代码。- - - - - -OpenACS这样历史文档

软件开发和文档并不总是携手并进。并不总是有明确的激励机制来记录软件的工作原理和它所做的,尤其是面对期限,模棱两可的用户组,和专利问题。但是文档改进采用软件,在一个合作的时代发展和platform-driven商业模式,增加用户的数量是关键。处理文档的挑战,社会规范,工具和技术出现,好的文档壁垒正在下降,和软件的经济形成了易用性和互操作性作为其主要的驱动程序。

从源代码到口语

自述文件,内联注释和源代码本身对于开发人员一直是可以接受的。大论文得出了最终用户的手册,多年来,但每次更新后很快成为过时。新工具,如Doxygen,自动创建文档的代码,提供类似的信息手册页在每个函数的输入和输出。随着互联网成为主要发布平台软件,更多社区主导型文档文化诞生了。开发人员现在写在许多网站和分享代码,等SourceForge和谷歌代码。GitHub已经成为最受欢迎的开放和封闭源代码的代码共享平台在互联网上,部分原因是他们强调写自述文件标准和减价、wiki和问题跟踪集成。然而,许多开发人员仅仅使用等问题&回答网站StackOverflow使用特定的软件。GitHub和StackOverflow使用元数据来分类软件,包括编程语言、许可和其他关键字。使用元数据,软件用户可以快速识别软件,适合他们的需求,使其更容易构建更大、更模块化的软件产品。

许多编程语言,例如NodeJS和Ruby与庞大的开发社区,结合模块化软件包管理即插即用发展迅速和容易。此外,机器学习和自然语言处理的进步让文档语义有关,形成模型或部分模型来解决问题。通常,文档可以帮助定义什么代码在编写代码之前。开发团队使用线框图、架构和其他描述性文件准确定义一个系统是如何工作的,翻译从想法到代码。

一个设计模式,文学编程,开头写一个过程在普通人类语言,然后转化为可计算的形式。如果做前期,这种类型的文档可以帮助翻译的想法从业务团队开发人员,允许更大的共同理解的想法。复杂的问题往往需要多种语言之间的翻译,人类和机器,使系统能够有效地工作。

总而言之

软件是我们日常生活的一部分,帮助解决问题或大或小。随着对软件需求的增长,市场也是如此。生产软件,与更多的人分享和协作的开发社区改善方法。网站致力于文档和学习,包括MSDN,中数,W3Schools大大增加了获取信息,间接增加了由所有开发人员的代码质量。代码共享的经济出现了网上所谓的开源运动,这使得软件几乎免费的成本。这已变成了“学习曲线”的驾驶成本采用新软件。因为文档极大地提高软件的可理解性,它已成为一个非常有价值的资产在软件市场。

所以问问你自己,你需要记录你的代码吗?