2023-02-08 Documentation Working Group Agenda/Meeting Notes

Technical Editor funding initiative can fund 4 months and the Marcia's contract is worked on

Martina will share news via Slack when available

Reporting: revamping reporting documentation

by focusing more on the practical usage of each tool vs. technical details

Eliana: Reporting Working Group met with Nassib (PO) – want to go in a different direction with documentation – a lot of documentation for LDP and Metadb is outside of docs.folio – it is used by ReShare as well – docs.folio: focus on absolute beginners as audience – not focusing on technical documentation, but on tutorials story based with personas for the different reporting tools - this is not consistent with the rest of the docs.folio   

Laura: it would be helpful – wondering do we have other examples for areas or modules that are not just in FOLIO? – If it is the first it would be a precedent and maybe the documentation will live somewhere else?

Dennis: to link out to the tutorials or to include them in docs?

Eliana: idea is to include the tutorials to the docs and link out to other documentation – those documentation is already updated separately from docs.folio 

Laura: not maintaining documentation in two places 

Eliana: we are a small group today – a small example of what this will look like and share it via Slack or the next meeting 

Martina: LDP App documentation is on docs – would this stay? 

Eliana: would like to prioritize the LDP App, LDP App documentation is in docs.folio not outside, (tutorial, high level information LDP App, link out)

Dennis: more to expand into more instructional documentation – might not live in docs.folio – could be a first pilot 

Eliana: docs.folio is manual right now – maybe to put somewhere else, but where, the Wiki may not be a good start for beginners to point at 

To come up with an outline and then we can discuss further and whether it belongs on docs.folio or elsewhere --> future meeting

Season of Docs application

topic postponed

Paul and Martina will ask Marcia

Documenting

• ERM Comparison
• Settings > Developer

• ERM Comparison: Felix volunteered to write a basic documentation
• Settings > Developer: Martina will ask Ingolf (SysOps Convener) if this can be discussed in SysOps SIG

Documentation theme (Docs.folio.org technical information)

and whether we want to look at a new one

topic postponed

Paul and Martina will ask Marcia

Laura suggested to have Marcia, Erin, Ian to attend the discussion as well. Might be a time-consuming explanations and discussion

Orchid public release is planned for April 10th

Orchid documentation deadline April 3rd