Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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:    Bess Sadler, Interviewer: Bess   - Option 3)
        • What happens when... I Search for Something (Expert: Jonathan Dixon, Interviewer:  - Option 2)
        • Patterns - Presentors Presenters (Expert: Adam Wead, Interviewer:  - Option 4)
        • Patterns - Actors (Expert: Tom Johnson, Interviewer: Jenn - Option 1) Email Questions on Actor Stack
        • What happens when... I Index Something (Expert: Justin Coyne, Interviewer: LaRita - Option 5)
      • help coordinate timing of documentation effort

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: Read out to Write the Docs community for organization question

...

  1. Welcome, Ryan Steans!
    1. How can we use Ryan's time to get more resources for documentation?
    2. We have some infrastructure in place for tracking versioning, but it's not ideal. Could we improve the template to better handle versioning?
    3. Can we hire someone to write some documentation? What would that look like? (Discussion ensued.) 
    4. Could they co-locate and organize existing documentation?
    5. Better structure or layout for documentation? 
    6. Lots of enthusiasm for hiring someone who really knows jekyll 
    7. Could we hire someone to organize a documentation sprint?
    8. Could we get some training for people about writing documentation?
    9. Can we host a "Write the Docs" event? How about a virtual event where we:
      1. Identify top priorities
      2. Identify who has the knowledge
      3. Pair (or triple) them up with someone who can interview them and take notes – or maybe it's a webinar?
      4. Process those notes after into digestable docs
  2. Proposal:
    1. Let's announce an event – what does it look like?
    2. Outcomes: Actual documentation


...


...

  1. restructure jekyll theme especially for left hand menu structure, addressing versioning across multiple gems, generalized organization of the site
  2. moving existing documentation spread across all the wikis to move the documentation to the centralized samvera.github.io site
  3. writing documentation (this requires some expertise that may present an obstacle)

...

  1. 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)
  2. Option 2: Paired developer - documentor virtual sprint – (perhaps 1-3 days in length)

...

More possibilities at previous meeting brain storming.