Git Product home page Git Product logo

guides's Introduction

Hack for LA Guides

The Guides project seeks to create guides out of the effective practices that we have created/iterated on projects in order to share replicable processes and practices so that we can continue to grow our peer learning and iterative culture, improving outcomes for the whole ecosystem.

Project context

The Guides will cover templates, how-to’s, and straightforward instructions to teach members of each communities how to

For more detail please read our Overview

Technology used

How to contribute

  • Join the HackforLA slack workspace
  • Join the slack channel #guides and say hi! Tell us your skillset and how you're looking to contribute.
  • One of our product managers will add you to the meeting invite & the project resources
  • Join our team meetings (these are subject to change based on need, if you can't make these times but you want to be on the team, let us know your availability on slack).
    • Friday 7:30-9:00 am (PDT) / 3:30-5:00 pm (WAT)

guides's People

Contributors

carolzjy avatar edwardsarah avatar experimentsinhonesty avatar sheisbukki avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar

guides's Issues

Cleanup Guide template: Identify grant areas and keywords for project #27

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
    • Add a copy of link to the resources, and then hide the comment
  • Take guide template from the related community of practice and insert it into the current guide issue, keeping all the existing content if relevant

Resources/Instructions

Revise Labels in Revenue CoP

Dependency

#59

Overview

We need to revise labels to address when items are ready for publication and when they have published

Action Items

  • Add all of the links indicated below
  • Rename the label "place guide" to be "ready publication"
  • Add new label "published"
  • Revise "review guide" to be "Needs Peer Review"
  • Revise all issues that refer to those labels
  • Revise all templates that refer to those labels

Resources/Instructions

Revenue Links

Guide Issue Template
Guide Labels
Guide Issues

Epic Issue #48

Create logo and hero

Overview

We need a logo for this project so that we can use it on our website and on the hackforla website project card

Action Items

  • get access to the figma
  • Find issue where Maria put the original globe dot image and its iterations
  • gather assets already used in the guides and add them to figma by inviting Alyssa to our figma
  • create a temporary logo
  • save logo onto 600x400 Figma logo work
  • create hero 1500x700 (the hero ideally has no text on it) Figma hero work
  • release dependency on issue #38
  • start working on a permanent logo

Resources/Instructions

Guides Team Figma
Issue where Maria put some globe dot images hackforla/product-management#88
Figma logo work
Figma hero work

Cleanup Guide template: Writing a One Sheet for your project #74

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Get final changes on screenshots done - see page 5 (see if we need to un assign current author)
  • reformat text
  • publish document

Resources/Instructions

Make Issues for CoP Audits

Overview

We need to make an issue for auditing each CoP's publication labels

Action Items

  • Make issues for each CoP
  • Add milestone
  • Drag into prioritized backlog based on milestone

Resources/Instructions

  • UI/UX #37
  • Product Management #47
  • Data Science #49
  • Marketing #50
  • Revenue #51
  • Dev Ops #52
  • Engineering #53

Create a Shared Drive and Roster Sheet for CoP and their Leads

Dependency

Oh Hold until guides issue is done #14, then rethink this issue

Overview

We need to create a shared drive for the Community of Practice repository.

Action Items

  • Create a shared drive for the Communities of Practice repository and invite all the members.
  • Create a folder for the roster under this shared drive and add members from all their rosters.
  • Request CoP leads to move their rosters to this shared drive.
  • Give access to Gautham.
  • Ask CoP leads to get leads to update their current roster and then let us know and post a comment here in this issue with link to the roster and that it has been updated.
  • Update Gautham once the above checklists are done, through this issue as comments.

Resources/Instructions

Cleanup Guide template: Terms and Conditions for your project #114

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
  • Take guide template from the related community of practice and insert it into the current guide issue,
    • Add a ink to the comment with the prior text, to the resources section,
    • Copy relevant portions in to above section
    • then hide the comment

Resources/Instructions

Convert Suggest a guide Template to Github Form Issue

Dependency

  • This is on hold until we figure out the whole workflow process for guides.
  • until MVP is ready to launch

Overview

As an issue creator, we want to implement issue templates for issue creation to streamline and simplify the process. The current issue forms require the person to replace the text, and is less user-friendly compared to GitHub Form issues.

Action Items

  • Define the form elements and their behavior
    • Review with product and Front End Lead
  • Create a suggest-a-guide.yml file in your own fork in: gh-pages/.github/ISSUE_TEMPLATE
  • Follow github form syntax readings below to code a similar form to the current issue template.
  • Get Signoff by Product on the proposed template before making a PR
  • Delete suggest-a-guide.md file in this folder

Resources/Instructions

Current Issue Template Code File
Github Forms Issue Reading
Github Forms Issue Reading Pt 2
hackforla/website#2128

To get signoff from product: put your issue in the Review column on the project board.

Tracking where are the guides are on CoPs repos and their status

Dependency

Once we have closed all the guides that have the label "Cleaup Guide"

Overview

We need to know where the workflow for Guide contributors live for each CoP so that we can standardize the process.

Action Items

  • Find all the CoP guide management boards (even if they are part of their regular board) and list them in the Resources below
  • Create a Spreadsheet with a High level overview audit to Identify how the templates and management are different from each other (gold standard is Product)
  • Draft plan for how they should work
  • Provide detailed CoP audit of each CoP, and what needs to change.

Resources/Instructions

audit spreadsheet-WIP

Organizations Google Drive: Hack for LA Guides

List of Community of Practice Guide Management Boards
Product Mangement
UI/UX
Ops - None
Admin - None
Revenue-Fundraising (No dedicated Guides Board)
Revenue-Earned Revenue - None
Engineering-Templates and Guides
Data Science-Administrative and Project Management Issues (No dedicated Guides board)
Marketing-Project Marketing (No dedicated Guides Board)

Create a project card for Guides on Hack for LA website

Dependency

Create logo & hero #39

Overview

We need to have a project card on the hack for LA website, so that we can recruit new team members

Action Items

  • Gather items for project card
    • logo on an image 600x400
    • hero image 1500x700
    • one sheet url (called overview on project card) #8
  • Add the content to hackforla/website#2289
    • Ask Bonnie to remove the dependency and put the issue into the prioritized backlog on hackforla website repo
    • Check to see progress on the issue

Resources/Instructions

Revise Labels in Dev Ops CoP

Dependency

#59

Overview

We need to revise labels to address when items are ready for publication and when they have published

Action Items

  • Add all of the links indicated below
  • Rename the label "place guide" to be "ready publication"
  • Add new label "published"
  • Revise "review guide" to be "Needs Peer Review"
  • Revise all issues that refer to those labels
  • Revise all templates that refer to those labels

Resources/Instructions

Dev Ops Links

Guide Issue Template
Guide Labels
Guide Issues

Epic Issue #48

Cleanup Guide template: Typography Effective Practices #48

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
    • Add a copy of link to the resources, and then hide the comment
  • Take guide template from the related community of practice and insert it into the current guide issue, keeping all the existing content if relevant

Resources/Instructions

Create folder structure in Google Project Drive

Overview

The Org needs to have a folder structure for the guides inside of the Organizations Google Drive: Hack for LA Guides, so that we do not loose access to the files.

Action Items

  • Create new folders that mimic the folder structure from the current shortcut folder
  • Write guidance for the CoP leads that tells them to give permission level contributor to their members when they add them to the Organizations Google Drive: Hack for LA Guides
  • Give access to the Organizations Google Drive: Hack for LA Guides to all Community of Practice Leads (Manager) and the guidance.
  • Message on slack about it.

Resources/Instructions

The Guides Team Will Talk to PM CoP About Guides

Dependency

when all the issues from the CoPs have been triaged

Overview

We need to itemize the key points the Guides team will talk about with PM CoP so that we have a structured list of issues to address when we meet.

Action Items

  • Create template for Guides training
    • create a slide using the photo template style and this video #58 (comment)
      • picture of Jenny from the video
      • quote from the video
      • logo of Atlassian
        • update the guides already made with the slide (it will go between slides 1 and 2)
  • Define what to talk about re Guides and build a deck/guide
    • How to find a new guide to work on #72
      • Update card on CoP as you finish the guide
        • UI/UX
        • PM
        • Admin
        • Engineering
        • DevOps
        • Revenue
        • Marketing
        • Data Science
    • How to find a guide to review #44 (comment)
      • Update card on CoP as you finish the guide
        • UI/UX
        • PM
        • Admin
        • Engineering
        • DevOps
        • Revenue
        • Marketing
        • Data Science
    • How to find a guide that has been started but not finished
      • Update card on CoP as you finish the guide
        • UI/UX
        • PM
        • Admin
        • Engineering
        • DevOps
        • Revenue
        • Marketing
        • Data Science
    • How to find a guide that is ready to write a template for
      • Update card on CoP as you finish the guide
        • UI/UX
        • PM
        • Admin
        • Engineering
        • DevOps
        • Revenue
        • Marketing
        • Data Science
  • Teach everyone how to self assign
  • How and where to move the issue once you are working on it (Move to In Progress)
  • Add card to the CoPs with the guide links
    • UI/UX
    • PM
    • Admin
    • Engineering
    • DevOps
    • Revenue
    • Marketing
    • Data Science

Action Items for Post the Guide publications on hackforla.org website

  • How to find a guide that needs edits - This will need to be looked at once we have guides that are considered done and ready for placement. It also would be helpful if we have a guide on the website so that we can cover all the edge cases. #44 (comment)
    • Update card on CoP as you finish the guide
      • UI/UX
      • PM
      • Admin
      • Engineering
      • DevOps
      • Revenue
      • Marketing
      • Data Science

The Challenge:
"We have a lot of new PMs who are unaware of Hack For LA's internal resources and how these could help them with their product management journey"

Message from Ebele, Product Management Community of Practice Co-Lead

I see that you're the PM for the Guides team and I was wondering if you could have a talk with the PM CoP about guides. We have a lot of new PMs who are unaware of H4LA's internal resources and how these could help them with their product management journey Let me know if you're interested and we can talk further. If not, please recommend someone else that could speak on behalf of the Guides team. Thanks!

Resources/Instructions

Recordings

Recording from Product Management CoP presentation on how to work on a New Guide
Start Time: Oct 27, 2021 05:46 PM
Meeting Recording
Access Passcode:

HaHx!&F2

Recording from 2nd Product Management CoP presentation on how to work on a New Guide (more recent presentation)
Topic: Product Management Community of Practice
Start Time: Oct 29, 2021 09:58 AM

Meeting Recording
Access Passcode:

C8bjypK$

Communications Guide folder

GP: CoP presentation draft all paths this draft has all of the paths. We are making one for each lesson

Draft Guides

GP: How to Gather Examples and Interview Teams for CoPs

PM
UX

GP: How to Review a Guide for CoP

PM, UX
Next step is to review all the paths (ui/ux, product, etc.) to make sure there are issues and a person can claim them. - likely this will be after bonnie finishes triage.

GP: How to Work on an Unfinished Guide for CoP

PM & UX

Here is the unfinished guide label for UI/UX results

GP: How to Find a Guide that is Ready to Write a Template for

[PM - Draft] - Thuy Le
PM - Draft Bonnie & Bukki]

In order to be able to make one for UX we need more issues with the template label. As of 2021-12-03 there is only one https://github.com/hackforla/UI-UX/issues?q=is%3Aopen+is%3Aissue+label%3A%22Guide%3A+Draft+Template%22

Presentations given

  • Product Management - October 27th and 29th 2021
  • UX has been given the presentations and has delivered them during the meeting November 17th 2021

Cleanup Guide template: Setting up Slack Reminders for your project #88

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Get changes made (check to see if maria is still working on this or unassign)
    • Update header
    • Change first paragraph to What is Guide format
    • Check against the current template (after kiki' changes have been integrated)
  • Publish the guide

Resources/Instructions

Cleanup Guide template: ui/ux #40 use Figma effectively on Open Source Volunteer Teams

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
    • Add a copy of link to the resources, and then hide the comment
  • Take guide template from the related community of practice and insert it into the current guide issue, keeping all the existing content if relevant

Resources/Instructions

Cleanup Guide template: UX/UI Accessibility #16

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Reach out to author to find out if they are still going to work on this
  • Provide guidance on how to use the How To Write a Guide template (WIP)
  • Review the guide once its made and identify how it is different from our template
  • Check to see if she has responded.
    • If not, reach out on slack.
  • Provide more guidance until finished
  • Signoff on Guide
  • Send Guide to Website Team
    • Add a copy of link to the resources, and then hide the comment

Resources/Instructions

One-Sheet for Guides Project

Dependency

Logo issue #39

Overview

As a Project Lead, I want a one-sheet for the guides project including milestones for the next 6 months so that we can recruit more members and speed up guides automation.

Action Items

  • Refer Civic Opportunity one-sheet.
  • Refer one more one-sheet example.
  • Create first draft of one-sheet.
  • Add one-sheet draft as link under Resources/Instructions section below.
  • Prepare questions for review.
  • Review the one-sheet draft with Bonnie.
  • add logo
  • create pdf
  • upload pdf to Finished one sheets location (see resources below)
  • add url of pdf to #38

Resources/Instructions

Guides one sheet
PDF of one sheet in our google drive
Location of Guides Team one sheet on the Product Management repo

Check this issue later to see if the template has been reverted to its original https://docs.google.com/document/d/1BCNkA3cEox1qp2803r1uDAtffEszQ2P34ZDHo4dKM0Y/edit#heading=h.n7lqzt5pn161

Folder with one sheet assets in it

Cleanup Guide template: Figma Effective Practices #20

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
  • Take guide template from the related community of practice and insert it into the current guide issue,
    • Add a ink to the comment with the prior text, to the resources section,
    • Copy relevant portions in to above section
    • then hide the comment

Resources/Instructions

Cleanup Guide template: How to setup Figma for teams #280

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Update tracker to reflect that this issue got moved to the admin community of practice
  • Add template to the Admin repository and Labels.
  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
  • Take guide template from the related community of practice and insert it into the current guide issue,
    • Add a ink to the comment with the prior text, to the resources section,
    • Copy relevant portions in to above section
    • then hide the comment

Resources/Instructions

  • Related Community of Practice: Product Management
  • Guide issue: hackforla/admin#19
  • Link to Guide: ?

Cleanup Guide template: How to write a donor acknowledgement #28

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
    • Add a copy of link to the resources, and then hide the comment
  • Take guide template from the related community of practice and insert it into the current guide issue, keeping all the existing content if relevant

Resources/Instructions

Cleanup Guide: How to make a pr

Dependency

The guides team is going to reformat this issue

Overview

We need to review this guide so that it does not hold up another guide.

Details

This guide is linked to from the how to create a one sheet issue and needs to be finished so that people can submit one sheets.

Action Items

  • review the process in the guide, provide feedback
  • provide feedback about format (currently uses old red outlines)
  • make sure it is linked in the one sheet guide under next steps

Resources/Instructions

hackforla/admin#43
Link to Guide: https://docs.google.com/document/d/1_J7x_Q6MmbPItHpQTst4r8p-V6fRBqxdNHsNbBXpvK4/edit#heading=h.z4tpbshl55b9
comment on how to create a one sheet issue hackforla/product-management#74 (comment)

Revise Labels in Marketing CoP

Dependency

#59

Overview

We need to revise labels to address when items are ready for publication and when they have published

Action Items

  • Add all of the links indicated below
  • Rename the label "place guide" to be "ready publication"
  • Add new label "published"
  • Revise "review guide" to be "Needs Peer Review"
  • Revise all issues that refer to those labels
  • Revise all templates that refer to those labels

Resources/Instructions

Marketing Links

Guide Issue Template
Guide Labels
Guide Issues

Epic Issue #48

Make a project Roadmap

Dependency

Move to In progress on 2021-10-08

Overview

We need a roadmap so that we know where we are going and can decide what to do next in order to reach our direction.

Action Items

  • Define goal of project
  • Define Objectives
    • order the objects in terms of priority
  • Create milestones
  • add milestone links to sheet
  • add current labels to the spreadsheet so that we can identify which of the milestones might be missing labels.
  • add milestones to all the issues
  • check in month to see if the milestones are working and what other improvements we might need to make.

Resources/Instructions

See one sheet

Goal

Grow HfLA’s peer learning and iterative culture and improving outcomes for the entire civic tech ecosystem.

Objectives

  1. Produce how-tos out of the effective practices in HfLA community
  2. Standardize existing guides into a consistent format and style
  3. Develop easy-to-follow instructions on how to create new guides
  4. Design procedures and systems to automate and accelerate the production of guides
  5. Work with the HfLA Communities of Practice to support their guide creation efforts and needs
  6. Devise plans to incentivize people to make and complete guides
  7. Serve as a platform/portfolio for guides authors to receive credit internally and externally for their work
  8. Create and maintain web pages to support the above objectives

Milestones and Objects to be sorted into how to achieve
Milestones page

Add issue template and labels to repo: Revenue

Overview

We need to have the Revenue teams be able to make guides that are consistent with the other guide so that they can be displayed together on our website.

Action Items

  • Copy the template from UI/UX repo to Revenue repo
  • Create the same labels that exist in template
  • Edit the template to have default label
  • Clear the dependency on issue #5 and move it to the prioritized backlog

Resources/Instructions

UX template
Revenue Guides Template

Agendas and Transcripts of meetings

Overview

This issue will hold transcripts and recordings for meetings so that we can refer back to them if necessary.

Action Items

  • Record meeting and turn on transcript
  • Upload recordings. Can only be done by Bonnie (they are on her machine)
  • Add Transcript of the meeting to the Resources section
  • Add Recording of the meeting to the Resources section

Resources/Instructions

All recordings

Cleanup Guide template: making a press release for your open source project #8

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
    • Add a copy of link to the resources, and then hide the comment
  • Take guide template from the related community of practice and insert it into the current guide issue, keeping all the existing content if relevant
  • Add the labels this repo needs in order to classify guides.

Resources/Instructions

Cleanup Guide template: Displaying your Civic Tech - Open Source - Volunteer Experience on LinkedIn #201

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
  • Take guide template from the related community of practice and insert it into the current guide issue,
    • Add a ink to the comment with the prior text, to the resources section,
    • Copy relevant portions in to above section
    • then hide the comment

Resources/Instructions

Cleanup Guide template:Defining Hack for LA identity #1

Overview

We need to cleanup this issue so that it has the current structure of guide issues.

Action Items

  • Review issue and identify next steps
  • Write to assigned person asking them why its on hold
  • Check reply
  • Annotate issue
  • Move the issue to icebox
  • write to author

Resources/Instructions

Cleanup Guide templates

Overview

We need to have templates for making the guides that cover the use cases and are definitive so that all the guides end up with a unified look and feel.

Action Items

  • Edit Guide to writing a guide
  • Edit screenshots etc guide
  • review all the leadership review guides to see if they reveal any specific elements that we should use in the guides guide.

Resources/Instructions

Guide: How to Write a Guide
HOW TO - ADD SCREENSHOTS & GRAPHICS TO YOUR GUIDE

Guides in Leadership Review

(see this spreadsheet for guides that have this status)
Copy of How to Organize your Project's Google Drive v1

Cleanup Guide template: Template for making composite images in our HfLA guides #55

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
    • Add a copy of link to the resources, and then hide the comment
  • Take guide template from the related community of practice and insert it into the current guide issue, keeping all the existing content if relevant
  • Make sure the status of the template is updated on the tracker hackforla/UI-UX#55

Resources/Instructions

Make labels for managing GitHub project board

Dependency

If we need a bunch of new labels.

Overview

We need labels so that we know what issues are about.

Action Items

  • Create labels for these types of activity
    • Create tracker for guides (feature: trackers)
    • Make individual issues for guides that are not working according to plan so as to clean them up (feature: cleanup guide)
    • Develop guidance for how to make guides (feature: guidance)
    • Create system to better track the guides between CoPs and Guides (feature: trackers)
    • Define how we are going to review guides in a timely way (feature: workflow)
    • Create a system that Incentivizes people to make and complete guides. (feature: evangelize)
  • Add feature labels to all existing issues
  • Identify issues that don't fit into feature labels by added a label called feature: missing
  • Make all the feature labels dark blue
  • Make feature label for administrative and apply to #8 #6
  • Add labels for role missing and role front end
  • Add size labels
    • 1
    • 2
    • 3
    • 5
    • 8
    • 13+
    • size: missing
  • on the issues tab, exclude all issues that have size or size missing, and then add the size missing label to what remains
  • On project board comment in bottom of Start Column, update to add the size missing on project board url

Resources/Instructions

https://github.com/hackforla/guides/labels
See CivicTechIndex for size labels https://github.com/civictechindex/CTI-website-frontend/labels?q=size

In issues tab
view issues that have role missing | view issues that are missing roles
view issues that have feature missing label | view issues that are missing features
view issues that have size missing | view issues that are missing sizes

Issues that have not been added to our project board

on Project board
view issues that have role missing
view issues that have feature missing

Create a ReadMe

Dependency

#8

Overview

We need to have a working READme file to easily onboard new team members and compile relevant information for other teams and CoPs that will interact with us.

Action Items

  • Review the readme file and identify what information is needed and applicable
  • Review GreenEarthOS repo as a guide
  • Review the project one sheet and other documentation to be used in creating content
  • Update project one sheet #8
  • Apply changes to ReadMe

Resources/Instructions

https://github.com/hackforla/guides/blob/main/README.md
Green Earth OS

Revise Labels in Product CoP

Dependency

#59

Overview

We need to revise labels to address when items are ready for publication and when they have published

Action Items

  • Add all of the links indicated below
  • Rename the label "place guide" to be "ready publication"
  • Add new label "published"
  • Revise "review guide" to be "Needs Peer Review"
  • Revise all issues that refer to those labels
  • Revise all templates that refer to those labels

Resources/Instructions

Product Links

Guide Issue Template
Guide Labels
Guide Issues

Epic Issue #48

Revise Labels in Engineering CoP

Dependency

#59

Overview

We need to revise labels to address when items are ready for publication and when they have published

Action Items

  • Add all of the links indicated below
  • Rename the label "place guide" to be "ready publication"
  • Add new label "published"
  • Revise "review guide" to be "Needs Peer Review"
  • Revise all issues that refer to those labels
  • Revise all templates that refer to those labels

Resources/Instructions

Engineering Links

Guide Issue Template
Guide Labels
Guide Issues

Epic Issue #48

Make template for Guides that only have 1 way of doing things and need no project examples

Overview

We need a guide template for when you are making something that only has one way of doing it, and multiple examples from projects are not necessary so that we have a streamlined process for making the guide.

Action Items

  • Identify Steps
  • Identify processes that require this type guides
  • Make template draft in comment below

Resources/Instructions

List of processes that require this type of guide

Figma https://github.com/hackforla/product-management/issues/280
(see issues in Admin repo)

Review all guides with Leadership Review status to provide feeback

Dependency

When we finish updating the templates for how to make a guide and add screenshots #14

Overview

We need to review the guides that have leadership review labels in order to let their authors know what they need change.

Action Items

  • Review guide
  • Add notes with check boxes in issue and on doc if appropriate
  • Paste in the template and customize for them
  • Remove Leadership Review label and Add Review Guide label
  • Move to In Progress column
  • Message them on Slack and note it in their issue and on here
  • Record which guide, issue and person we messaged in spreadsheet.
Hi @________  , my name is Bukki, I am the new Guides PM.  Thank you for putting so much work into you guide.  Looks like we are almost finished !!! 🥳🎉

I have given your guide a review and added some notes.  I know it has been a while, if you are unable to work on this issue anymore, please let me know so that I can put it back into the prioritized backlog and un-assign you.

[Insert link to issue]

Template

Thanks for doing great work on the guide.  Here are the notes from the Leadership review (guides team)
- [ ] Please update the following (see the guides in resources for examples of formatting)
- [ ] [insert your comments]
- [ ] Header 
- [ ] Footer

#### Resources
- [HOW TO WRITE A GUIDE
](https://docs.google.com/document/d/1-8gmeC-wnfM8C8fVvmTP1BLA2WfNjKH_XJrHB1OAV6Q/edit#heading=h.qpz414wzo9l)
- [HOW TO ADD SCREENSHOTS & GRAPHICS TO YOUR GUIDE
](https://docs.google.com/document/d/1OyPfKqUU7ZinhjMoRmsXywyZfME_Oo_hpC2Zdxlb310/edit#heading=h.30j0zll)

#### When completed with changes
 - [ ] remove the "Review Guide" label and replace with "Leadership Review" label
 - [ ] move to Review column on project board

Resources/Instructions

HOW TO WRITE A GUIDE

HOW TO ADD SCREENSHOTS & GRAPHICS TO YOUR GUIDE

Leadership Review communication tracker

Links to find all the relevant guides

Product Management

UX

Clean up the current templates/guide issues that didn't use our standard: Revenue

Overview

We need to cleanup the issues that are already there so that we don't duplicate or miss guide opportunities.

Action Items

  • Review every open and closed issue on the board to look for any that could be or suggest the idea of a guide and do one of the following:
    • Make a new issue and copy relevant content
    • Add the idea to a list of guides that need to be made
    • Edit issue to turn it into a guide issue.
  • For any issue already marked Guide, make sure it has the status labels

Resources/Instructions

Revenue issues
Revenue guide related issues
Revenue Guide Status Labels

Change meeting invites

Overview

We need to reorg our meetings so that we have the most productive time and they reflect the actual.

Action Items

  • Separate Friday from weekly meeting
  • Make a M and W that starts at (with timezone)
    • 7:30am -8:30 for Bukki and Bonnie
    • 8:30 - 9:00 for Bukki, Bonnie and Alyssa

Gather Requirements: Tracker

Overview

We need a tracking application (either built or bought) for the guides in order to ensure the pipeline runs smoothly.

Action Items

  • Identify team requirements (add to comment below)
  • perform user research
  • document user requirements/preferences
  • perform research with other orgs to find out what tools they use for their help files and pain points/opportunities
  • prioritize features
  • Create a list of possible tools
  • do Comparative/Competitive analysis on tools

Resources/Instructions

Tracking where are the guides are on CoPs repos and their status: #2

Current method for tracking guides:

  • Issues in each repository with label systems
  • Spreadsheets in some CoPs
  • Spreadsheet in Guide Team Google Drive
  • Various Issues in Guides Team repository for tracking guide issues that are non standard

Cleanup Guide template: Figma for developers (written by their friends at UI/UX) #27

Dependency

move this out of the icebox and into review on 2021-11-12 - see comment at bottom of this issue.

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

Resources/Instructions

Revise Labels in Data Science CoP

Dependency

#59

Overview

We need to revise labels to address when items are ready for publication and when they have published

Action Items

  • Add all of the links indicated below
  • Rename the label "place guide" to be "ready publication"
  • Add new label "published"
  • Revise "review guide" to be "Needs Peer Review"
  • Revise all issues that refer to those labels
  • Revise all templates that refer to those labels

Resources/Instructions

Data Science Links

Guide Issue Template
Guide Labels
Guide Issues

Epic Issue #48

Review Done Columns of CoPs

Overview

We need to update labels in done column of each CoP so that they reflect the recent label changes.

Action Items

  • Add all of the links of the done columns from CoPs project board below
  • look at any issues in the done columns of CoPs to see if they need labels changes
  • Revise tracker with the above
  • Revise tracker for Admin to add the label Add published to admin only

Resources/Instructions

UX

Cleanup Guide template: Website Style Guide and Design System #24

Dependency

Bonnie and Hana meeting on Monday at 1pm
"Answer Please show me what you are creating at our next meeting (2021-08-30)"

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Make a copy of the current top of the issue and put it in a comment below so that we can keep it if we need to retrieve any of the prior content.
    • Add a copy of link to the resources, and then hide the comment
  • Take guide template from the related community of practice and insert it into the current guide issue, keeping all the existing content if relevant

Resources/Instructions

Cleanup Guide template: Figma Auto-Layout #62

Overview

We need to cleanup this create a guide issue so that it has the current structure of guide issues.

Action Items

  • Copy what Danielle and Hana from the Design Systems team said into the Resources section.
  • Update our tracker to make sure that this issue properly categorized.

Resources/Instructions

Revise labels in UX CoP

Dependency

#59

Overview

We need to revise labels to address when items are ready for publication and when they have published

Action Items

  • Rename the label "place guide" to be "ready publication"
  • Add new label "published"
  • Revise "review guide" to be "Needs Peer Review"
  • Revise all issues that refer to those labels
  • Revise all templates that refer to those labels

Resources/Instructions

UX Links

Guide Issue Template
Guide Labels
Guide Issues

Epic Issue #48

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.