Versioned Executable User Documentation for In -development Science Tools

被引:0
|
作者
Boisson, C. [1 ]
Ruiz, J. E. [2 ]
Deil, C. [3 ]
Donath, A. [3 ]
Khelifi, B. [4 ]
机构
[1] LUTH, Observ Paris, Paris, France
[2] CSIC, Inst Astrofis Andalucia, Granada, Spain
[3] Max Planck Inst Kernphys, Heidelberg, Germany
[4] Univ Paris Diderot, APC AstroParticule & Cosmol, Paris, France
关键词
D O I
暂无
中图分类号
P1 [天文学];
学科分类号
0704 ;
摘要
One key aspect of software development is feedback from users. This community is not always aware of the modifications made in the code base, neither they use the tools and practices followed by the developers to deal with a non-stable software in continuous evolution. The open-source Python package for gamma-ray astronomy Gammapy, provides its user community with versioned computing environments and executable documentation, in the form of Jupyter notebooks and virtual environment technologies that are versioned coupled with the code base. We find that this set-up greatly improves the user experience for a software in prototyping phase, as well as provides a good workflow to maintain an up-to-date documentation.
引用
收藏
页码:357 / 360
页数:4
相关论文
共 50 条
  • [1] Exploring User Experience of Automatic Documentation Tools
    Wu, Shengnan
    Zhou, Yangfan
    Wang, Xin
    EXTENDED ABSTRACTS OF THE 2021 CHI CONFERENCE ON HUMAN FACTORS IN COMPUTING SYSTEMS (CHI'21), 2021,
  • [2] API documentation with executable examples
    Hoffman, D
    Strooper, P
    JOURNAL OF SYSTEMS AND SOFTWARE, 2003, 66 (02) : 143 - 156
  • [3] Utilizing dynamic executable models for user interface development
    Lehmann, Grzegorz
    Blumendorf, Marco
    Feuerstack, Sebastian
    Albayrak, Sahin
    INTERACTIVE SYSTEMS: DESIGN, SPECIFICATION, AND VERIFICATION, PROCEEDINGS, 2008, 5136 : 306 - 309
  • [4] Documentation Tools Development for Rehabilitation Technology Implementation
    Frisoli, Melisa
    Poux, Sofia
    Deris, Melisa
    Catalfamo Formento, Paola
    Garcia Anino, Eloisa
    ADVANCES IN BIOENGINEERING AND CLINICAL ENGINEERING, SABI 2022, 2024, 105 : 305 - 314
  • [5] In Continuous Software Development, Tools Are the Message for Documentation
    Theunissen, Theo
    Hoppenbrouwers, Stijn
    Overbeek, Sietse
    ICEIS: PROCEEDINGS OF THE 23RD INTERNATIONAL CONFERENCE ON ENTERPRISE INFORMATION SYSTEMS - VOL 2, 2021, : 153 - 164
  • [6] The information in the origin and development of science of the documentation
    Lopez Yepes, Jose
    INFORMACION: PERSPECTIVAS BIBLIOTECOLOGICAS Y DISTINCIONES INTERDISCIPLINARIAS, 2015, : 253 - 265
  • [7] Interconnecting documentation - Harnessing the different powers of current documentation tools in software development
    Prause, Christian
    Kuck, Julia
    Apelt, Stefan
    Oppermann, Reinhard
    Cremers, Armin B.
    ICEIS 2007: PROCEEDINGS OF THE NINTH INTERNATIONAL CONFERENCE ON ENTERPRISE INFORMATION SYSTEMS: ARTIFICIAL INTELLIGENCE AND DECISION SUPPORT SYSTEMS, 2007, : 63 - 68
  • [8] USER-INTERFACE DEVELOPMENT TOOLS
    LEE, E
    IEEE SOFTWARE, 1990, 7 (03) : 31 - 31
  • [9] USER DOCUMENTATION
    EISCHEN, M
    AMERICAN CITY & COUNTY, 1983, 98 (07) : 18 - 18
  • [10] INTEGRATING DOCUMENTATION TOOLS AND TECHNIQUES INTO THE ENGINEERING DEVELOPMENT ENVIRONMENT
    DOLKAS, JB
    EIGHTH ANNUAL INTERNATIONAL PHOENIX CONFERENCE ON COMPUTERS AND COMMUNICATIONS: 1989 CONFERENCE PROCEEDINGS, 1989, : 360 - 364