|Editors||Werner Goebl, David M. Weigl (trompamusic)|
|Date of last access||06.02.2022|
|Affiliation||Mozarteum Foundation Salzburg|
Software tool: A “Tool” is broadly defined as a computational application to be used for accomplishing one task or a number of related tasks in the process of digital scholarly editing.
Virtual Reseaerch Environment (VRE): An “environment” is defined as a platform on which various tools (independent or not) are working as an integrated whole in order to perform a series of tasks or to cover the entire workflow.
What type of software is it?
|Identification of the environment
Operating system: e.g. for stand-alone applications
Web browser: for web-based applications, web-services, and APIs
Another application: i.e., a plugin
On which platform runs the tool?
For what purpose was the tool developed?
|developed for a specific project or materials|
Which is the financial model of the tool?
What is the development stage of the tool?
|Methods and implementation|
Which programming languages and technologies are used?
Does the tool reuse portions of other existing software?
Which input formats are supported?
|.xml, Other: .xml/mei|
Which output formats are supported?
|.xml, Other: .xml/mei|
Which character encoding formats are supported?
Is a pre-processing conversion included?
Does the documentation list dependencies on other software, libraries or hardware?
If yes, is the software handling the installation of dependencies during the general installation process (you don’t have to install them manually before the installation)?
|Documentation and support|
Is documentation and/or a manual available? (tool website, wiki, blog, documentation, or tutorial)
Which format has the documentation?
Which of the following sections does the documentation contain?
|‘Getting Started’ section (installation and
In what languages is the documentation available?
Is there a method to get active support from the developer(s) or from the community?
|From of support||
Which form of support is offered?
Is it possible to post bugs or issue using issue tracker mechanisms?
|Usability and sustainability|
|Build and install||
Grade how straightforward it is to build or install the tool on a supported platform:
Is there a test suite, covering the core functionality in order to check that the tool has been correctly built or installed?
|Portability and interoperability||
On which platforms can the tool/software be deployed?
|Linux/BSD/Unix, Mac OS X, Windows|
On which devices can the tool/software be deployed?
If the tool is web-based: On which browsers can the tool/software be deployed?
|Not applicable (if not web-based for example)|
If the tool is web-based: Does the tool rely on browser plugins?
Is there an API for the tool?
Is the source code open?
Under what license is the tool released?
Does the software make adequate acknowledgement and credit to the project contributors?
Is the tool/software registered in a software repository?
If yes, can you contribute to the software development via the repository/development platform?
|Analysability, extensibility, reusability of the code|
Can the code be analyzed easily (is it structured, commented, following standards)?
Can the code be extended easily (because there are contribution mechanisms, attribution for changes and backward compatibility)?
Can the code be reused easily in other contexts (because there are appropriate interfaces and/or a modular architecture)?
|Security and privacy||
Does the software provide sufficient information about the treatment of the data entered by the users?
|Supportability and maintenance||
Is there information available whether the tool will be supported currently and in the future?
Does the tool supply citation guidelines (e.g. using the Citation File Format)?
|User interaction, GUI and visualization|
What kind of users are expected?
|Humanities researcher, Digital humanist|
What kind of user interactions are expected?
|Text editing, Visualization|
What kind of interface does the tool provide?
|Graphical User Interface (GUI)|
Does the tool provide a particular visualizations (in terms of analysis) of the input and/or the output data?
Is the user allowed to customize the functioning of the tool and the output configuration?
Does the tool provide particular features for improving accessibility, allowing „people with the widest range of characteristics and capabilities” to use it?
Weigl, David M.