M720Report

From Scratchpad Wiki
Jump to: navigation, search

M7.20 - Workpackage software documentation produced

Due
31 October 2013
Delivered
23 October 2013†
Purpose
To record how our software works to encourage its uptake and use, and to facilitate its enhancement and maintenance.
Benefit
The immediate benefit is that the software requires less personal support as user and developer questions may be addressed in the documentation. The longer term benefit arises from the increased likelihood that the software will be taken up by others in the biodiversity community after the completion of ViBRANT, because they have material to help them understand the software. As such this documentation contributes to ViBRANT's sustainability plan.

† Documentation was written during software development. As the software was enhanced during ViBRANT so the documentation was updated in step. The date recorded here is when the milestone was reported as completed, given that the software has now reached a stable end point within the project.

Developer documentation

Where appropriate installation documentation is included in each product. For an example from RefParse, see https://git.scratchpads.eu/v/refparse.git/blob/HEAD:/README.txt.

Where appropriate usage documentation is included in each product. For an example from RefBank, see https://git.scratchpads.eu/v/refbank.git/blob/HEAD:/API.txt.

User documentation

Where appropriate end user documentation is included in each product. For an example from RefBank, see screenshot below.

(thumbnail)
Screenshot of help notes accompanying RefBank's search dialog.


Screenshot of help notes accompanying RefBank's search dialog.

Workpackages
EMonocot
Personal tools