Documentation plan
Users
- Biomedical researchers without CLI experience who would mostly use the GUI
- Biomedical researchers with CLI experience who could use GUI or CLI
Documentation for users
Both groups of users are provided setup information in our GitHub README.
Both groups of users will be provided information about how to use the GUI in the form of status tips and tool tips in the GUI. This will be our primary source of GUI documentation because it is easily accessible, and the user can choose which elements to learn more about without being bombarded with irrelevant information.
They will also be provided information about JSON setting configuration in our GitHub README and in the JSON itself in the form of comments. Both are immediately obvious sources of information, and users won’t have to be informed of their existence.
For people using CLI, we provide information about CLI options in our README.
-h CLI option) in READMEUser documentation
As mentioned in the Documentation Plan section, both groups of users will be provided information about individual GUI elements in the form of status tips and tool tips in the GUI. This information will be the same for both groups.
For users interacting with the CLI, we provide information about CLI options in the README, as shown above.
Administrator documentation
Our program does not involve any setup, deployment, or maintenance of a system. It is a stand-alone cross-platform (Windows, macOS, Linux) application, so an administrator is not needed.
The only setup requirement is installation of the Python dependencies via pip, which is described in our README.
For future developers interested in the internals of the program, that information is automatically generated from code docstrings and deployed to our documentation site. As time allows (i.e., this probably won’t happen), we could create a page describing which functions are called in which order for the contouring process.
The automatically generated source code documentation provides a high-level overview of our program.
Links
https://headcircumferencetool.readthedocs.io