NHMDenmark / Mass-Digitizer

Common repo for the DaSSCo team
Apache License 2.0
1 stars 0 forks source link

Digitiser guide for using the app (new process and version 1.1.18 / 1.2 needs updating) #428

Closed PipBrewer closed 8 months ago

PipBrewer commented 9 months ago

What is the issue ?

The user guide is referring to Beta release 2.11 and we are at production release 1.1.18 - many of the screen shots are out of date and need to be replaced. The new functionalities are lacking description:

The "Mass Digitisation App workflow and user guide" can be found in this directory: N:\SCI-SNM-DigitalCollections\DaSSCo\Workflows and workstations\Herbarium\MADDApp

With the release of version 1.1.18 (which will probably be updated to 1.2 once the workbench 
script has been revised),the guide for digitisers (Chelsea is the owner of this document) 
should be updated to match it.

Why is it needed/relevant ?

The guide for digitisers should be up-to-date and relevant and can be used for reference for
 whoever is doing the digitising. This is especially important for non-digitisers, such as 
collection managers who do not digitise as frequently and may not be as well informed 
of changes to the app.

Estimate level of effort required.

easy

What is the expected acceptable result.

The guide is up-to-date and reflects the current app, especially the UI and agreed processes.

We have a clear process for updating this document in future.

Additional information


Whilst Chelsea is the owner of the document and is ultimately responsible for it, including 
checking any updates make sense and conform to style etc, actually updating the guide is
sometimes best done by the person who made the changes to the app and should be 
accompanied by training Chelsea on the new features. 

The date that the documentation should be updated by should be specified and / or negotiated. 

This process should always happen before the release of a new version of the app. 

The version number of the document should be updated. Whilst updates are in progress,
the final part of the version number can increment. Once all changes have been agreed, 
the second part of the version number can be changed and the document released. 

Once an updated document is released, all potential users of the app should be notified
 on slack (All DaSSCo digitisation) and a link/copy of the document distributed.
jlegind commented 9 months ago

Draft of new version of the User guide was sent to @chelseagraham for review.

jlegind commented 9 months ago

Path: N:\SCI-SNM-DigitalCollections\DaSSCo\Workflows and workstations\Herbarium\MADDApp

jlegind commented 8 months ago

Updates from Chelsea have been accepted.

jlegind commented 8 months ago

Awaiting final test on the new workstation tower. Will be done on 27-10-2023.

jlegind commented 8 months ago

User guide updated with instructions on how to make app and DB-browser available to the shared account.