Instructions are out of date, too generic, or difficult to follow |
“The long command line inputs are quite unwieldy to use. For the command line it would be beneficial to explain the components of the syntax.”
“The command provided for how to run the software is very generic, but I would prefer a more detailed example on using command to analyze a specific file.”
|
Lack of useful onscreen feedback undermines user confidence |
|
Screen walk-throughs are highly desirable |
“A lot of information to sort through in ‘overview’ but demo helpful. Screenshots walking through more helpful than code just displayed on screen.”
“The readme is extremely hard to understand. Screenshots and videos will be helpful.”
|
Use of jargon/acronyms should be avoided |
“The documentation page can be made more informative by providing links to the definition of jargon/acronyms. For example, ‘CVD’ GUI, ‘XCAS’ File, ‘CPE’ Descriptor, Load ‘AE’. A first-time user will get lost in these acronyms.”
|
Installing and using prerequisites are very difficult |
“Too many prerequisites required which makes the system nearly impossible to install.”
“For each prerequisite, it is better to list the steps online, other than providing a link. Although all prerequisites are available online, and they all have somewhat good documentation, the authors should restrict from providing information in a minimalist style.”
|