2022-03-14
March 14, 2022
Host: Mark Titchener
Secretary:
Attendees:
Apologies:
Michael Dolan (TSC) - Epic Games
Evan Wilson - Blender Foundation
Update from Michael (on Slack)
As an update from my end, I've continued to work on ocioview
, the GUI application for editing and analyzing OCIO configs. I hope to have a demo to share at the next meeting. Also, there is some discussion happening in the TAC about technical writing resources which could potentially be hired by the ASWF. I think our UX guidelines would be a good place to start with this for OCIO, if it's approved. Would it help for this group to write up a proposal for this work?
Technical writing resources proposal
Carol: What’s the intention with moving to Confluence. Will the guide remain here or be moved into official OCIO documentation?
Mark: We started with the Google doc as it was easier to collaborate on initial ideas. As sections were refined we felt Confluence was a better place to store them longer term. We talked about the possibility of moving into the official documentation eventually.
Doug: Didn’t have a clear short term goal as such but using Confluence is easier than creating pull requests.
Carol: TAC has been discussing projects need for documentation. It’s a common theme that was recently brought up in the open source forum.
Carol: Some representatives from The Linux Foundation attending the open source forum had experience with documentation needs on previous LF projects.
General advice was it’s better to contract based on work completed rather than a full time person floating around.
This approach also helps projects prioritise their documentation needs.
Carol: Whatever the approach, we need to have something written to submit to the TAC for them to review e.g. what do we need and why?
Mark: So we’d have two separate documents, one high-level proposal for the TAC and then one more detailed brief for a technical author?
Carol: Yeah. Could be one doc if that’s easier and we can pull out the relevant points for the TAC.
Mark: Two is fine.
Carol: Can just be bullet points to start, we can fill in details as we go.
Doug: I like the idea of hiring someone on pay as you go terms. My concern with having a full time technical author is we might not be able to keep up with the amount of work/input they would need from us.
Carol: There’s also Google Season of Docs as an option but I don’t know about timings on this yet.
Carol: There is a TAC meeting next Wednesday (03/23). Would be great to have a written proposal in place for that if possible.
Doug: I should also be able to join that TAC meeting.
TODO: Mark to start and share a proposal document for the TAC.
Items for next meeting agenda
Possible demo from Michael of
ocioview
, a GUI application for editing and analyzing OCIO configs.