[meta] Plan user guidance and documentation

[chrisdburr]

This issue will be used to track the progress of our project page's documentation.

Todos

• [x] Setup module tracker page
• [ ] Link HackMD to GH directory for asynchronous co-working
• [ ] Add individual issues to projects tracker
• [ ] Organise documentation sprint

Links

• HackMD Documentation Tracker: https://hackmd.io/@tea-platform/B1GsUAGep

[chrisdburr]

I've setup a new documentation branch for us to start drafting these sections, once we've agreed on the scope and structure: https://github.com/alan-turing-institute/AssurancePlatform/tree/documentation/site/docs/guidance

[chrisdburr]

Started the draft for the introductory section, 'What is Trustworthy and Ethical Assurance': https://github.com/alan-turing-institute/AssurancePlatform/commit/a014db8ce83a527b387864f1671ddef72ca13c20

[kallewesterling]

I can try to set aside some time to work on setting up a structure and start drafting a bunch of these things, but considering the mention above of "agreeing on the scope and structure", perhaps let's hold off until after Thursday's check-in with you @chrisdburr, @AoifeHughes and I?

[chrisdburr]

That's fine. It's a longer piece of work, and something to discuss with @S-Laher as well.

[kallewesterling]

Do we also want to ensure that we scope some documentation for contributing to the codebase as well, as we're launching this as an open-source project?

[chrisdburr]

Do we also want to ensure that we scope some documentation for contributing to the codebase as well, as we're launching this as an open-source project?

Yes. Please could you and @AoifeHughes suggest some pages/topics that should be included? And, maybe @cassgvp can add suggestions from a CM perspective (e.g. improvements to code of conduct, PR templates).

[cassgvp]

👆🏻 Great idea. Please ping me when you want to discuss/co-work on this.

[chrisdburr]

I have created a separate document to track the project page's documentation, including user guidance modules (e.g. general skills and capability building), case studies, and platform documentation (e.g. API documentation, deployment instructions): https://hackmd.io/@tea-platform/B1GsUAGep

I think we should plan for a documentation sprint at some point in November/December @kallewesterling

[kallewesterling]

@chrisdburr I wanted to pick up on this issue, where you mention that you want a documentation sprint in Nov/Dec. Since we're over half the November down already, what're your feelings around this? Was there anything in particular that you had in mind for the documentation?

[chrisdburr]

Couple of things here:

1. Some of the documentation will need to wait until after the work with Fruto, as user guidance will need to reflect the latest version of the UI (e.g. screenshots).
2. I think we should still try to find time in one sprint before the end of the year to review and focus on outstanding documentation. There is still work we could do that doesn't depend on the redesign.