Documentation management

[Davsarper]

Goal Title

Comprehensive and clear documentation for the DSH, SATRE & TRESA will ensure open, reproducible outputs from this project.

Description

• Ensure all relevant information is captured in documentation
• Test accessibility and discoverability of docs with relevant groups
• Iterate documentation in line with wider project work (e.g. TRESA processes, DSH updates)
• Determine what can/can't be documented (e.g. from an IG perspective).

Definition of Done

When funding ends for the project and we have openly documented everything that we feel we can

Details

• RACI
  • Accountable team or person: RAM, RCM
  • Responsible team or person: REG, RPM
  • Informed and consulted people:
• Estimated effort
• FTE: 0.2
• REG Support FTE 0.05 (ongoing effort low, may have spikes) - added by RPM
• RPM: 0.05 (higher but already included in RPM Accountable tasks)

Task and issue breakdown

Breakdown in specific tasks of maximum a month duration, tasks and issues may be added as necessary
Issues may span across repositories when necessary

• issue alan-turing-institute/data-safe-haven-team#X
• issue alan-turing-institute/data-safe-haven#X
• issue alan-turing-institute/trusted-research
• issue sa-tre/satre-specification#X
• issue sa-tre/satre-team#X

Checklist

• This Story have been agreed with project members, it tackles prioritised work
  • If not: Label as ForPrioritisation so it discussed in the next monthly meeting, do not set a status
• I have filled in the Team Accountabe field
• I have included this Story in the agreed upon Milestone, set status as Planned
  • If not: set status as Backlog, to be Planned via weekly meetings or async discussions
• The work to be done is likely to span over a month
• I have broken down the work in monthly issues and added them above
• I have labeled this issue according to its main project: SATRE, TRESA, CORE DSH (ELA) or other (please agree and create a new label if necessary)
• I have stimated the total effort and added it in the body (under Details) but left the issue field blank

[Davsarper]

@jemrobinson & REG what effort from you do you think this would take? Considering you are not Accountable but do contribute to it and are Responsible.
Similar to #27 but also beyond (DSH docs may not only be TRESA docs)

[jemrobinson]

Finalising a first version of the docs is probably several FTE weeks work in each case. Ongoing maintenance should be very low once this is done.

[Davsarper]

October: best effort situtation, Hari on leave most of the time.
Pulumi will require a new push on docs in November. A sprint week could be a good solution for it