Create a Guide/Template: Zeroheight Documentation Tool

[daniellex0]

Overview

We need to create a guide for Zeroheight so that UX designers at HfLA can document their design systems

Action Items

The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.

• Gather Examples Solo (open in a new tab)
• Gather Examples Collaboratively
• Create a Guide Draft
  • If needed, create a template
• Have your guide peer reviewed
• Present your guide for leadership review

Resources/Instructions

• Google Drive Folder for this Guide’s documents and shortcuts (to documents in other locations)
  0127 Zeroheight Documentation Tool

Projects to Check

Tasks

• This is where you will copy instructions from the wiki page for the step you are currently on.

Resources

Draft

• Guide: Zeroheight

[Aparna1Gopal]

As per Instructions moving this to prioritized Backlog

[JesseTheCleric]

Prior version of issue

Overview

We need to create a guide for Zeroheight so that UX designers at HfLA can document their design systems

Action Items

• Research existing information about Zeroheight in relevant resources, articles, etc.
  • Once done, remove the "Guide: Research" label and add the "Guide: Gather Examples" label
• Gather examples of how other projects or volunteers have done this (if applicable), adding each example as a link in the resources section below
  • Once done, remove the "Guide: Gather Examples" label and add the "Guide: Draft Guide" label
• Create a draft guide, either in markdown format in this issue or a google doc in the [ux/ui google drive]
  • Once done, remove the "Guide: Draft Guide" label and add the "Guide: Review Guide" label
• Review the guide with UX/UI community of practice
  • Make any changes indicated by comments if you understand them. If you do not, reply to the person who made the comment, asking for what you need clarification on.
    • If this guide would be improved by making a template Figma file, add that to these action items and update the label
  • Ask for new reviews until no suggestions for improvements are left
  • Once done, remove the "Guide: Review Guide" label and add the "Guide: Leadership Review" label
• Present to the Hack for LA leadership team for sign off
  • Once approved, remove the "Guide: Leadership Review" label and add the "Guide: Place Guide" label

Resources

Use this guidance from the Guides Team to help you finish the Zeroheight guide

• How to Work on an Unfinished Guide (PM CoP presentation)
• How to Peer Review a Guide (PM/UX CoP presentation) - This guide has already been peer reviewed, but after you make the changes it will need to be peer reviewed again

Draft

• Guide: Zeroheight

[JesseTheCleric]

Assignee, Labels, Project Board Placement, and Milestones for this issue in the UI/UX Repo:

[JesseTheCleric]

Files in this Issue

Guide Draft

• This file has been moved to the knowledgebase-content Google Drive

How to Work on an Unfinished Guide (PM CoP presentation)

• This document will not be moved to the knowledgebase-content Google Drive because it is not relevant to this guide issue. Reason: Document consists of generic Guide instructions not relevant to specific issue

How to Peer Review a Guide (PM/UX CoP presentation) - This guide has already been peer reviewed, but after you make the changes it will need to be peer reviewed again

• This document will not be moved to the knowledgebase-content Google Drive because it is not relevant to this guide issue. Reason: Document consists generic Guide instructions not relevant to specific issue