Use of Ryan's time
- Explore hiring someone one or two people with the skills to restructure jekyll theme and redesign organization of the documentation.
- Coordinate a pilot of small scale documentation sprint.
- Documentation approaches
- Option 1: Documentor interviews a domain expert.
- Option 2: Domain expert does a brain dump in writing. Documentor refines this and asks more questions through email/slack to add details and refine writing.
- Option 3: Documentation webinar interview with all participants being able to ask clarifying questions. Provide some questions ahead of time.
- Option 4: Documentor creates questionnaire to send to domain expert.
- Option 5: New developer creates documentation as they think it works and then the domain expert helps to refine it until correct.
- Coordination
- identify experts
- identify documentors
- identify topics
- Running in production - (Experts: , Interviewer: Bess - Option 3)
- What happens when... I Search for Something (Expert: Jonathan Dixon, Interviewer: - Option 2)
- Patterns - Presentors (Expert: Adam Wead, Interviewer: - Option 4)
- Patterns - Actors (Expert: Tom Johnson, Interviewer: Jenn - Option 1)
- What happens when... I Index Something (Expert: Justin Coyne, Interviewer: LaRita - Option 5)
- help coordinate timing of documentation effort
- Documentation approaches
Action Items: Ryan to coordinate pilot and contacting experts and interviewers.
Use of Financial Support
- restructure jekyll theme especially for left hand menu structure, addressing versioning across multiple gems, generalized organization of the site
- redesign the organization of the documentation especially on how to organize versioning across multiple gems
Action Items: How to locate someone with the skills? Potentially reach out to our current theme author. (5 hours of Ryan's time for initial exploration)
Action Items: Read out to Write the Docs community for organization question
- Welcome, Ryan Steans!
- How can we use Ryan's time to get more resources for documentation?
- We have some infrastructure in place for tracking versioning, but it's not ideal. Could we improve the template to better handle versioning?
- Can we hire someone to write some documentation? What would that look like? (Discussion ensued.)
- Could they co-locate and organize existing documentation?
- Better structure or layout for documentation?
- Lots of enthusiasm for hiring someone who really knows jekyll
- Could we hire someone to organize a documentation sprint?
- Could we get some training for people about writing documentation?
- Can we host a "Write the Docs" event? How about a virtual event where we:
- Identify top priorities
- Identify who has the knowledge
- Pair (or triple) them up with someone who can interview them and take notes – or maybe it's a webinar?
- Process those notes after into digestable docs
- Proposal:
- Let's announce an event – what does it look like?
- Outcomes: Actual documentation
- Welcome, Ryan Steans!
- Potential uses for the financial support
- restructure jekyll theme especially for left hand menu structure, addressing versioning across multiple gems, generalized organization of the site
- moving existing documentation spread across all the wikis to move the documentation to the centralized samvera.github.io site
- writing documentation (this requires some expertise that may present an obstacle)
- Use of Ryan's time
- Organize short term focused documentation effort that can be used as a prototype for bi-annual documentation efforts
- Option 1: Webinar style with a primary interviewer but that anyone in the community can attend and ask questions (would need to be shorter for Webinar part and use followup meetings for clarification and document writing)
- Option 2: Paired developer - documentor virtual sprint – (perhaps 1-3 days in length)
- For both options,
- there needs to be a prioritization process of which docs to write that includes the general prioritization of the working group AND voting by the community
- determine the number of features/processes that we can document during this effort
- there needs to be an identification process of the developer expert for that area and an appropriate documentor to capture the knowledge in documentation
- Organize short term focused documentation effort that can be used as a prototype for bi-annual documentation efforts
- Potential uses for the financial support