Outstanding Items for the Segmented Gather Example Presentations

[edwardsarah]

Overview

A list of action items for the smaller gather example presentations so they can be completed.

Action Items

Edits Based on Presentations Reviews

• [ ] Part 3 Video copying text needs to be remade and given a voiceover
• [x] Part 4 Update exercise on finding your counterparts with exercises for additional CoPs
• [x] add slide somewhere in decks talking about best way of organizing responses (ex. spreadsheet, comments, etc.)
• [x] Make all title slides & TOC title case
• [x] Reformat Next Steps slide in all decks - how do we want to format this in Part 4?
• [x] Make test slides with icon changes

Notes for Further Discussion

• is there a way to default to slideshow mode but allow them to escape it (not using preview mode)? right now, cannot send the slides out in preview mode
  • can we put speaker notes for exercises in a wiki page (and later on its own webpage) instead so we can keep things in preview mode? we will revisit when we look at other speaker notes
• Slide 19 deck 2: has examples for two communities of practice but no others - do we want to do something about this? (ex. including ops or data science)
• follow up on slide 28 to make sure that the information on project board cards is correct (re: decomissioning)
• Do we care that it's very easy to navigate forward from one presentation to another, but not to move backwards (ex. from part 2 to part 1) - added an overview deck to help correct this
• Add searching discussions to gathering examples

Resources/Instructions

Original Gather Examples Presentation:

• GP: How to Gather Examples and Interview Teams

  Smaller Presentations:

• 1 What is a Guide & Picking Your First Guide

• 2 Gathering Examples: Github [Wiki, Issues, Project Board, Resources Provided]

• 3 Gathering Examples: Slack

• 4 How to Connect w/ Other Teams, Moving the Conversation Forward, How to Interview Practitioners

• 5 Making a Special Issue & Last Check w/ Org Rep

[edwardsarah]

Moving forward from: https://github.com/hackforla/guides/issues/105#issue-1209810402

[edwardsarah]

Do we want to make slack method 5 and resources provided method 4? The way the presentations are currently split up, it goes 1, 2, 3, 5 in the first presentation, and then method 4 in its own presentation.

[SheIsBukki]

Do we want to make slack method 5 and resources provided method 4? The way the presentations are currently split up, it goes 1, 2, 3, 5 in the first presentation, and then method 4 in its own presentation.

Yes, I have edited them accordingly

[edwardsarah]

switched the contents of the table of contents and the section contents in presentation 3 based on discussion we had last week. otherwise, I don't think there's currently any other edits we need to make to the presentation.

[SheIsBukki]

switched the contents of the table of contents and the section contents in presentation 3 based on discussion we had last week. otherwise, I don't think there's currently any other edits we need to make to the presentation.

Awesome!

[ExperimentsInHonesty]

There have been some changes made so the table on contents needs to be rechecked

[ExperimentsInHonesty]

I used this clipart of a monitor on one of the slides https://hdclipartall.com/monitor-clipart-monitor-clipart-850_706-156447.html

[edwardsarah]

The colored boxes in Part 5 don't seem to conform to the standards of colored boxes in the other presentations, can we discuss this on Monday?

[edwardsarah]

'Benefits for you as X' boxes

• Part 1 has one (sort of) on slide 8
• Part 3 has one on slide 5
• Parts 4 & 5 have none

Part 2 has 'benefits for x' boxes on each method intro slide, and a slide dedicated to the overall benefits of gathering examples

• Wiki
• Issues
• Project Board Card
• Resources Provided

[edwardsarah]

Change all boxes to what to observe w dashed border

[edwardsarah]

@SheIsBukki did you have a chance to review the slide decks yet? if you leave a comment on parts where we need steps and don't have them yet I can help fix those slides for Friday

[edwardsarah]

Part 1 has been checked completely and does not need another review.

[edwardsarah]

Speaker Notes in Presentations: none in part 1 or part 3, except the link to Bonnie's linkedin page that shows up on every Contributors page

Part 2:

• slide 19 (an exercise)
• slide 25 (link to an example issue used)
• slide 26 (an exercise)

Part 4:

• slide 5 (template text)
• slide 6 (links to example issues used)
• slide 7 (template text)
• slide 8 (links to example issued used)
• slide 9 (template text)
• slide 11 (link to flowchart)
• slide 14 (template text & example responses)
• slide 17 (template text)

Part 5:

• slide 6 (additional example)
• slide 10 (template text)
• slide 11 (template text)
• slide 12 (template text)

[edwardsarah]

used in part 3

from google material symbols

[edwardsarah]

Updates ahead of 1/6 meeting:

• Glossary words identified on slides and added to footer.
• Section on slack files has been updated with screenshots for an example shared in multiple slack channels.
• Additional slide in part 4 about where to look for you counterpart + slide with exercise on finding counterparts with examples for PMs & Dev team.

[ExperimentsInHonesty]

@seannwvong is going to start with How to Make a Guide: Overview and leave comments on it in any place that something is not clear, and then link that slide here in a list

[seannwvong]

How to Make a Guide: Overview

review and comments

• [x] Slide 3: TOC
  • These are top level sections with black slides, except for these which can be moved all be under an Appendices section that has its own black slide.
  • Links to Resources Mentioned
  • Appendix: Additional Resources
  • Glossary which links out and is also under "Additional Resources"
  • I also find the use of different 2 different templates disorienting. Most have the black bar at the bottom but some have the black bar at the top, like TOC, and appendices. Because the section headers have "Guides Projects" at the bottom, using the template with the bottom black bar flows better.
• [x] Slide 5: What is a Guide?
  • After going through the deck, it seems there's a process to creating a guide. It would be useful for me to have a flowchart with boxes and arrows representing the stages of creating a guide, between this slide and "First Steps"
• [x] Slide 6: First Steps
  • I found this confusing because this step is called "Gathering Examples Part 1", but this slide is not under the Gathering Examples section. I kept wondering if this is not part of "Gathering Examples", or is it for background for context. Since the folder for Parts 1-5 is "Gathering Examples Presentation", it could be clearer to move this slide into the Gathering Examples section.
• [ ] Slides 6, 8, 9
  • UX nitpick: boxes usually indicate secondary information e.g. good to know, danger, context, call outs. The info in the grey boxes seems just as important as the text on white backgrounds. I think this can be laid out a little better, but info is generally ok.
• [x] Slide 9: Reaching out to Teams
  • What is a special issue, because it seems important enough to warrant a deck of its own. It's not briefly explained here.
• [x] Slide 18: Icon Legend
  • This list of legends can be sorted with Google Slides and Google Docs at the top. The rest of the icons are not used and can be removed if not required, but there are also links to wiki pages that don't use the wiki page icons, so the use of these icons are inconsistent.
• [x] Slide 20: Q&A
  • We should populate this slide with some of the questions we get often.

[edwardsarah]

Titles of the presentations (and references to them within the presentations & the overview deck) have been edited to reflect the decision we made last Friday to separate Part 1 (now 'What is a Guide') from the rest of the Gather Examples decks.

[seannwvong]

What is a Guide & Picking Your First Guide

review and comments

• [x] Slide 1:Cover
  • [x] Added hyphen to change to "Self-Assigning"
  • [x] The "How to Make a Guide: Overview" cover slide is red. I thought it was black when I reviewed. Should the cover slides of other decks be red also for consistency?
• [x] Slide 2: Purpose
  • [x] Should "Guide team be "Guides team"?
  • [x] In the "How to Make a Guide: Overview" Purpose slide, this line has a wiki icon at the end, but there's no icon here. We should be consistent.
• [ ] Slide 6: How to See Guides in Process
  • [ ] Will there be a wiki where others can see the guides that are ready? It's not immediately clear to me on the Kanban board which guides are "done done".
  • [ ] Side note: the Kanban board definition is "visual system used to manage and keep track of work as it moves through a process." The Guides Tracker Kanban columns appear to morph into a grouping area of different statuses when we scroll to the right; doesn't exactly illustrate a process. Happy to learn more about different nuances and how/if we can optimize this.
• [x] Slide 7: Guide Types & Examples
  • [ ] The intent of this slide at this point in the deck to highlight 2 types of guides is sound but the examples are not Guide examples. They are all issues and checklists on how to create the guide. As a reader I would have to dig further to find the actual guide. Perhaps it could be listed as Managing your project's Slack channel (guide | issue) if there are different links for each guide.
• [x] Slide 10: How To Find the right Complexity Level
  • [x] At this point of the deck I haven't actually seen a Guide so I'm not sure where I would see this label.
  • [x] If the guide doesn't have the complexity labels, should users read that as "this is unscoped" and hang on before starting to create the guides?
  • [x] Who does the scoping and labelling for each guide?
• [x] Slide 11: Find a New Guide to Work on
  • [x] I think it might be useful to have screenshots with issues that have the Complexity labels to emphasize the previous slide.
  • [x] Added a screenshot of an issue with a complexity label to the previous slide
  • [x] Only Ops have scoped the guides, but they are in point format, not Complexity labels. There should be some consistency in what we're trying to communicate complexity.
  • [x] Glossary for Prioritized Backlog should appear here as it's the first appearance.
  • [x] What's the difference between Guides here and Guides in the Guides Tracker? Do they display the same guides i.e. the Guides Tracker is a roll up of all the Guides in the CoP?
• [x] Slide 12: How to Select a New Guide
  • [x] I think the crosses and ticks are examples that can be verbally presented but it isn't clear how as a reader I should understand why the middle one is a tick for everyone.
  • [x] Prioritized Backlog first appeared in Slide 11 but I'm fine with displaying glossary here.
• [x] Slide 16: Congrats
  • [x] At this point of communicating "how to create guides", would "Overview" have been presented already? Listing Overview here as a next step and after Gathering Examples seems confusing. Also not immediately clear what "Overview" is overview for or why. May I suggest another bullet point to describe if readers want to find out more about the overview of creating guide, see the Overview(link) deck.

[seannwvong]

Part 1: Gathering Examples With Github [Wiki, Issues, Project Board, Resources Provided]

review and comments

• [x] Slide 5: Benefits from Gathering & Cataloging Examples

  • [x] Author definition in glossary is vague. "A person who writes the guide. Other people who work on a guide but are not drafting the majority of it are contributors. The first person to make a guide document is listed first under contributors at the bottom of the guide." 1st and 2nd line distinguishes authors from contributors but the subsequent line groups authors and contributors under the contributors section. Update Glossary: Add Words with new definition for Author

• Slide 9: How to Find and Copy the Projects List and their Repositories

  • Updated bullet list of projects into a checklist so that it becomes a checklist when copied. Reverted to bullets after review. Checking a list item only marks it complete at that point in time, but the guide is a living document that ccan still be worked in the future by others. So in this context a bullet list is more suitable.

• [ ] Slide 13: Methods for Gathering Examples from Teams

  • Took the liberty to link to the respective sections Reviewed: ok to keep if there's a good reason to do so. Please note that previously it was also linked and then removed because we don't want people to jump ahead. We want them to go through this list to familiarize themselves with GitHub.
  • [ ] Struggling with this verb. The method is the same - checking all these areas. Should this be "sections in GitHub" where we should search for? Reviewed: In general, we use the word "method" because we're describing elements of a methodology. Method: a method for looking something, looking for something, or a project has employed to deal with data. Consider using the word "approach"? To ask leads in the UI/UX CoP and Engr CoP meeting that for this deck, would they prefer Method, Approach or another word that would be more accessible to their teams.

• [x] Slide 19: Method 1: Exercise

  • [x] Rephrased from "when finding" to "to find"
  • [x] Add a slide to talk about what the right hand column modules would look like.
    1. Default tree of pages
    2. Manually created component that the team has created
    3. Manually created component that the team has heavily customized.
  • [x] Tweak "multiple options" based on the the new slide.

• [x] Slide 22: Method 2: Use the Filter on the Issue Tab

  • [x] Create additional slides before this to show how to use labels before showing how to use filters. Methods 2.1, 2.2, 2.3 are under notes in Slide 26: Method 2: Exercise.

• [x] Slide 28: Method 3: Using Project Board Cards

  • [x] Would/Should we (the ones crafting the guide) view cards? Is this section still relevant? We should explain we should still check out the classic project boards because there's where the historical data would/might be. The comms style here should be positive i.e. what we can see and why, not just a negative i.e. beta boards don't allow cards.

• [x] Slide 29: Method 3: What is a Project Board Card Link?

  • [x] Previous slide calls out "project board card" and this slide talks about "project board card link". They appear synonymous but are not exactly the same. Slide 34 references copying a link to the relevant cards. For this slide we should remove the word "link".

• [x] Slide 41: Next Steps

  • [x] Added new slide based on last week's discussion on creating "journey" overview. Probably need UX designer to improve it.

• [ ] NEW DECK: Create a separate deck for using GitHub global search before the Slack deck. Reason for create a new deck is to have new members be familiarized with how projects are constructed in GitHub.

[edwardsarah]

Non-presentation Questions

• What date is the CoP leads meeting next month & what time are these meetings generally at?

New Slides / Slide Updates

Overview

• Not sure if we got to it last week, but slides 6-9 are new. 6 & 7 are reworked to include the additional steps we talked about, and 8 we discussed adding two weeks ago. I still have to make sure all of the WIP labels have been added to the correct decks.
• Leadership review slide has been edited to mention reaching out to your CoP leads when you're ready for leadership review. There's a lot going on in this slide, so maybe we should split it into two?

How to Use Github Search

• Basically all of the slides in What You Can Search have been reworked. Does the flow make sense? Is there a better way to organize this information?
• Search search syntax slide updated with examples. Is it too busy?

  How to Ask for Peer Review

• Comment Etiquette Slide Added Any suggestions on better examples of bad & good feedback are welcome

Part 3: Connecting with Other Teams

• Finding Your Counterpart Exercise has been edited to focus on Access the Data for the Dev exercise rather than the website team. I did one run through with the UI/UX exercise to make sure it matches the format of the other two, but will probably need to check it again. It should be ready for review next week.

Blockers/Questions

• Editing some steps in how to ask for peer review are on hold until I understand what's standard across CoPs. This will just require a little more looking around on my part. Not every CoP uses the same columns on their guides board or the exact same labels for their guides.
• Does it make more sense to format Finding Your Counterpart Exercise in Part 3 by having them make a spreadsheet? I can put together an example for next week if there's interest.

My Next Steps

• Adding an exercise to the GitHub search deck
• How to Ask for Peer Review slide deck needs screenshots & template text. I will look around in issues/CoP slacks to see if there are any examples I can pull from from there, otherwise I might as UI/UX if they have any suggestions
• How to Peer Review a Guide needs a few slides on wrapping up the peer review process & formatting changes like fixing the appendix & 'map' slide at the end
• Overview needs to be updated with Github global search deck

[edwardsarah]

Presentation Updates

How to use Github Search

Slide 4: Added a link to the wiki search slide in part 1

Part 3: Reaching out to other teams

• Checked the exercise again, I think it's okay now?