论文标题
记录开源框架的模式
Patterns for Documenting Open Source Frameworks
论文作者
论文摘要
记录框架为其用户和维护者提供了有关该软件架构，设计和自定义的有用信息。尽管文档的重要性，但创建和维护它的过程被认为意味着巨大的努力，乏味和昂贵。 在这项工作中，我们挖掘了从开源框架的模式，以发现用于记录尚未被描述为模式的良好解决方案。这个过程产生了四种新模式。 “贡献指南”可以帮助开发人员成为项目的贡献者，帮助他们遵循其维护者采用的良好实践。 “文档版本”包括为框架的较旧版本提供单独的文档，以在此类版本上回答用户的需求。 “迁移手册”可帮助用户从框架的先前版本迁移到较新版本。 “多语言支持”允许使用几种语言翻译文档，以支持框架的更广泛的用户。
Documenting frameworks provides its users and maintainers useful information on that software's architecture, design, and customization. Despite documentation's importance, the process of creating and maintaining it is considered to imply considerable effort, to be tedious, and expensive. In this work, we mine patterns from open source frameworks to uncover good solutions used to document them that had not yet been described as patterns. This process resulted in four new patterns. "Contribution Guidelines" helps developers to become contributors to a project, helping them follow the good practices that have been adopted by its maintainers. "Documentation Versioning" consists of having separate documentation for older versions of the framework, to answer needs of the users on such versions. "Migration Handbook" helps users migrating from previous versions of the framework to newer ones. "Multi-language Support" allows translated documents in several languages to support a wider range of users for the framework.
