Updating Guide Template

[edwardsarah]

Overview

The guide template needs to be updated to match the current structure used in admin guides.

Action Items

• [ ] Review sections in admin templates
• [ ] Update guide template with relevant sections
• [ ] Review other finished guides for any additional sections / omitted sections
• [ ] Check https://github.com/hackforla/knowledgebase-content/issues/106 for relevant feedback
• [ ] Discuss at team meeting if we want to add or make certain sections optional

Resources/Instructions

Template: Guide Guide: How to Format a Guide

[edwardsarah]

Sections in Guide: Log Into a Google Account w/ 2-Step

• What is in this Guide?
• Alternatives or Things to Know?
• What is 1 Password?
• What is 1Password's One-Time Password Feature?
• What is a Google Account?
• Prerequisite for Using this Guide
• How to Use this Guide
• Step by step instructions
• Troubleshooting
• Guide Authors

Sections in How to - Add Team Members to a 1Password Vault

• What is this guide or process?
• Alternatives or things t know?
• What is 1Password?
• Preqrequisite for Using Guide
• How to Use this Guide
• Step by step instructions
• Guide Authors

[edwardsarah]

@ExperimentsInHonesty I tried to look at guides by the admin team other than the two mentioned above by looking at the issues on the templates and guides project board labeled guide creation but I don't have access to any of them. Since a lot of these are from early 2022, are they still up to date?

[edwardsarah]

Completed Guide

How to Add Screenshots and Graphics in a Guide

• doesn't follow standard format, is a guide for guides

How to Create a MIRO Account

• 1) What is this Guide or pRocess 2)Alternatives or things to know 3)What is MIRO? 4)Prerequisites for Using this Guide 5) How to use this guide w/ step-by-step instructions

Effective Communication Practices for Developers and Designers

• Doesn't conform to standard template, reads more like a list of principles than a step-by-step set of instructions, which is fine for this particular type of guide. But we should consider how we're going to factor this into the template

[edwardsarah]

How to Organize Your Project's Google Drive

• sections: 1) what is google drive 2) step-by-step instructions

How to Create a Readme for Your Project

• honestly not a great guide, would not recommend it as a resource
• Sections 1)What is a readme 2)where can I find it 3)How to update it 4) information on updating it (with examples)

How to Run a Usabilityhub.com survey

• Structured as a presentation, not a document
• 1) what is usabilityhub 2) how to login 3) how to create a survey 4) examples of different surveys & their results

Guide for UX Experience Profile

• a presentation, not a document
• overview + step-by-step instructions

Guide: UX Researchers Toolkit

• Probably not a good example because it's not specific enough to Hack for LA and our unique practices
• 1) Table of Contents 2) What is UX Research? 3)Types of UX Research 4)Types of UX Testing 5)Types of Methodologies 6)Tools Used 7) References

How to Write a One Sheet

• 1) What is a One Sheet 2)Create an Issue 3)Updating an Existing One Sheet 4)Create a New One Sheet 5)Find Information 6)Update the One Sheet Issue 7)Issue Checklist 8)Finalize Updates 9)FAQ

How to Guide Qualitative Feedback

• More of a list of principles than a step-by-step guide

Accessibility Guide

• Not specific to Hack for LA & our practices

How to Set Reminders in Slack

• 1) What is slack 2)When to use reminders 2) How to use reminders 3)Examples 4)How to Delete Reminders

https://github.com/hackforla/knowledgebase-content/issues/66

• this file has been deleted

How to Conduct Usability Tests

• this guide is very long! it should probably be broken up
• 1) What is in this guide? 2)How to use this guide? 3)What is a usability test? 4)Types of usability tests 5)Conducting a test 6) Appendix

Guide: Zeroheight

• Of the off-template ones I've reviewed, I like this one best
• 1) Table of Contents 2)What is Zeroheight? 3)Product Overview 4)Workflow 5)Case Study 6)Resources

https://github.com/hackforla/knowledgebase-content/issues/81

• can't find this guide? may have been deleted

How to Write a Research Plan

• 1) What is a research plan 2)Alternatives/Things to Know? 3)How to Use this Guide? 4)Sub-sections devoted to different parts or things to consider in a research plan

Practical Applications for Code of Conduct

• Overview section (Unlabeled) 1)Steps for dealing with a violation when it doesn't involve a PM 2)Steps for dealing with a violation when it does involve a PM

How to Work on an Issue at Hack for LA

• 1)What is in the guide? 2)Prerequisites or things to know? 3)When will you work on github issues? 4)How will you report your progress? 5)What if you need to stop? 6)How to Assign & Unassign People from issues 7)How to move issues on the kanban board 8)How to change labels
• feels like it could potentially be split into different guides (ex. How to Use the Kanban Board, How to Use Labels)

[Designers: How to Present Your Work]

• List of principles, and a checklist

Designers Toolkit, Comparative or Competitive Analysis, PM Interview Guide