[论文解读] Ten Essential Guidelines for Building High-Quality Research Software

Nasir U. Eisty, David E. Bernholdt+3 more|ArXiv.org|Jul 22, 2025

Scientific Computing and Data Management被引用 3

一句话总结

本文提出十条高质量研究软件编写指南，涵盖规划、模块化设计、编码规范、版本控制、测试、同行评审、文档、可复现性、性能与长期维护。

ABSTRACT

High-quality research software is a cornerstone of modern scientific progress, enabling researchers to analyze complex data, simulate phenomena, and share reproducible results. However, creating such software requires adherence to best practices that ensure robustness, usability, and sustainability. This paper presents ten guidelines for producing high-quality research software, covering every stage of the development lifecycle. These guidelines emphasize the importance of planning, writing clean and readable code, using version control, and implementing thorough testing strategies. Additionally, they address key principles such as modular design, reproducibility, performance optimization, and long-term maintenance. The paper also highlights the role of documentation and community engagement in enhancing software usability and impact. By following these guidelines, researchers can create software that advances their scientific objectives and contributes to a broader ecosystem of reliable and reusable research tools. This work serves as a practical resource for researchers and developers aiming to elevate the quality and impact of their research software.

研究动机与目标

• 需要明确指南以提高研究软件的鲁棒性、易用性和可持续性。
• 提供一个可应用于新旧项目的实用、高层次框架。
• 推动研究软件工程师（RSE）在研究小组中执行软件质量的角色。
• 将软件工程的原则与科学计算和可复现研究的具体需求对接。

提出的方法

• 概述涵盖整个开发生命周期的十条综合指南。
• 为每条指南提供具体实践与示例（规划、模块化设计、整洁代码、版本控制、测试、同行评审、文档、可复现性、性能、维护）。
• 讨论这些指南如何应用于新代码库和遗留代码库。

实验结果

研究问题

• RQ1 哪些做法构成高质量研究软件在规划、开发、测试与维护方面的要点？
• RQ2 研究人员和RSE如何在新旧项目中实施并适应这些指南？
• RQ3 结构化指南对研究软件的可重复性、可维护性和可用性有何影响？

主要发现

• 指南强调规划和模块化设计以提升可维护性和可重用性。
• 整洁、可读的代码和一致的风格有助于协作与长期性。
• 版本控制、定期测试和同行代码评审是可靠性与可重复性的核心。
• 文档与可复现的工作流程对可用性和可信结果至关重要。
• 在集成对性能和可扩展性的考虑时应避免过早优化。
• 长期维护（包括CI/CD与社区贡献实践）有助于在开源和遗留项目中的可持续性。