Automated support for framework documentation

对框架文档的自动支持

• 批准号: 311672-2011
• 负责人: Robillard, Martin
• 金额: $ 2.11万
• 依托单位: McGill University
• 依托单位国家: 加拿大
• 项目类别: Discovery Grants Program - Individual
• 财政年份: 2012
• 资助国家: 加拿大
• 起止时间: 2012-01-01 至 2013-12-31
• 项目状态: 已结题
• 来源: https://www.nserc-crsng.gc.ca/ase-oro/Details-Detailles_eng.asp?id=508282
• 关键词: Automated; support; framework; documentation

Software development organizations rely on application frameworks to build applications. Frameworks provide implemented and tested solutions to recurring requirements, and allow organizations to invest their efforts in innovative, value-adding development through the reuse of software infrastructure. Large frameworks must be supported by extensive technical documentation, which can include reference manuals, tutorials, and code examples. Despite the fact that developing and maintaining framework documentation now requires a major investment, very little is known about the impact of the documentation system on the framework's learnability, and very little automation exists to help organizations manage framework documentation. The goal of this research program is to investigate how automatic techniques can be used to support the development and maintenance of framework documentation. In the short term, we target the development of automated techniques to a) analyze existing documentation and usage data to recommend improvements and updates; b) dynamically adapt documentation systems to users needs based on user modeling techniques; c) automatically create tutorial examples based on software version history mining. For the longer term, we plan to build on our understanding of framework documentation to expand the research to address other pertinent issues in framework usability, and in particular the problem of efficiently querying framework documentation. The research methods for all three objectives will involve a combination of exploratory empirical studies, algorithm and prototype tool development, and validation studies using both active participants and archived project artifacts. The proposed work has the potential to significantly impact how organizations produce and utilize framework documentation and may help organizations shift from a handcrafting approach to a semi-automated documentation creation and management approach supported by advanced software analyses. The research will also involve extensive re-thinking of existing software artifact analysis techniques to account for the unstructured and pedagogical aspects of software documentation.

软件开发组织依靠应用程序框架来构建应用程序。框架为重复需求提供已实施和经过测试的解决方案，并允许组织通过重用软件基础设施将精力投入到创新、增值开发上。大型框架必须得到广泛的技术文档的支持，其中可以包括参考手册、教程和代码示例。尽管开发和维护框架文档现在需要大量投资，但人们对文档系统对框架可学习性的影响知之甚少，而且帮助组织管理框架文档的自动化也很少。该研究计划的目标是研究如何使用自动化技术来支持框架文档的开发和维护。在短期内，我们的目标是开发自动化技术：a）分析现有文档和使用数据以提出改进和更新建议； b) 基于用户建模技术，动态调整文档系统以适应用户需求； c) 基于软件版本历史挖掘自动创建教程示例。从长远来看，我们计划基于对框架文档的理解来扩展研究，以解决框架可用性中的其他相关问题，特别是有效查询框架文档的问题。所有三个目标的研究方法将涉及探索性实证研究、算法和原型工具开发以及使用积极参与者和存档项目工件的验证研究的结合。拟议的工作有可能对组织生成和使用框架文档的方式产生重大影响，并可能帮助组织从手工方法转变为由高级软件分析支持的半自动化文档创建和管理方法。该研究还将涉及对现有软件工件分析技术的广泛重新思考，以解释软件文档的非结构化和教学方面。