Create a Guide/Template: Writing a One Sheet for your project

ktjnyc commented 3 years ago

Overview

Product Managers need a guide to assist with writing a One Sheet so that all One Sheets follow a similar formula and contain all the necessary pieces of information regarding a project.

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
Draft guide
https://github.com/hackforla/product-management/issues/3
One Sheet Template

Projects to Check

Tasks

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

ktjnyc commented 3 years ago

@Olivia-Chiong can you review my draft and let me know if you have comment/suggestions?

Olivia-Chiong commented 3 years ago

@ktjnyc this is great. Please move to review column for @ExperimentsInHonesty to review. Thanks!

ktjnyc commented 3 years ago

@Olivia-Chiong - When I click on the links for the issue templates for the One Sheet, it doesn't have all the information we added during review of this document last week. Can you please update the templates to include the below?

Add instructions for all the other items that need to be updated for creating the issue.

Overview

Create the project one sheet so it can be shared with stakeholders and funders.

Action Items

[ ] Check to confirm project does not already have a one sheet
[ ] Make a copy of the one sheet and store in the product management google drive/one sheet revisions
[ ] Review one sheet and check off items on the checklist to see what it might be missing.
[ ] Setup a meeting with the PM to go over the project to confirm what information on the sheet is up to date and what needs revision.

Checklist

[ ] Include project logo (top right)
[ ] Overview
[ ] History and or last 6 months
[ ] Partners
[ ] Roadmap/next 6 months
[ ] Contact email (footer)
[ ] Github URL (footer)
[ ] Link to project page on hackforla.org (footer)
[ ] Slack channel (footer)
[ ] Last updated date (footer)
[ ] Hack for LA logo (bottom right)

Resources/Instructions

Check issue hackforla/product-management#3 for sample one sheets

Olivia-Chiong commented 3 years ago

@ktjnyc I just fixed it. try loading it again?

ktjnyc commented 3 years ago

Thanks, now I see three templates - Create a NEW One Sheet: [Project Title] - This is the one I linked to and looks good

Update Existing One Sheet: [name of project] - I think this one needs to have the checklist updated to match the above Update One Sheet: [name of project] - Not sure we need a third - might be able to be deleted?

Olivia-Chiong commented 3 years ago

deleted the extra and updated the existing. Take a look

ktjnyc commented 3 years ago

Thanks! One more small update to this Create a NEW One Sheet: [Project Title]

Instead of :

[ ] Make a copy of the one sheet and store in the product management google drive/one sheet revisions

Should be:

[ ] Make a copy of the one sheet template and store in the product management google drive/one sheet revisions

Olivia-Chiong commented 3 years ago

made the change, but wondering if we want to add a link to the one sheet Google drive folder.

ktjnyc commented 3 years ago

I put instructions in the document where to save the files. I think we could link to the template document but I don't think we have one yet.

Once this guide is done we can add it to the links section as reference as well.

ExperimentsInHonesty commented 3 years ago

@Olivia-Chiong and @ktjnyc I want to give you all a review on this. But I am unclear what I am supposed to be looking at. Can you add a comment that gives me explicit instructions on what I should do?

ktjnyc commented 3 years ago

@ExperimentsInHonesty I made edits to the draft we had reviewed a few weeks ago - the draft linked here is ready for your review.

ktjnyc commented 3 years ago

Send out note to PM Slack channel requesting peer review.

alexilee commented 3 years ago

Peer review:

Overall, the guide is very detailed and easy to follow
It may be helpful to have an FAQ and address the question of, "What happens when the product managers are not responsive?" as this seemed to be the most common yet most detrimental obstacle
Does the duplicate Google Doc ever replace the original one sheet? Or do multiple copies of a one sheet exist after a one sheet is updated?
You may be able to reduce the title to "Guide: How to write a One Sheet for HfLA" so it fits on one line

kcoronel commented 3 years ago

Peer review;

I agree with Alex and believe an FAQ at the end or the beginning of the document may be more helpful in folks looking to join a project. At this moment the document is a useful PM tool

ExperimentsInHonesty commented 3 years ago

@ktjnyc I updated the template to reflect the format form the best of docs. This should help with the Engage one sheet as well as the guide you are drafting.

ag2463 commented 3 years ago

Peer Review -The document is clear and easy to follow -Agree with previous comments re: what happens to multiple versions of One Sheets -A FAQ section would be helpful, but how would that continue to get updated and added to once the guide is published?

DrIffathsultana commented 3 years ago

Peer Review

Guide is clear with all the links and information
How often guide needs to be updated. Is there a timeline?

ktjnyc commented 3 years ago

Incorporated comments and feedback from peer review and attempted to apply format from Slack Reminders Guide. Ready for review. Draft guide

henlatourrette commented 3 years ago

Peer review: I really like the design, it's easy and fun to read. Well done so far!

Perhaps I would add a comment saying that "you can check this issue for examples" or something similar.

ktjnyc commented 3 years ago

Incorporated new comments and feedback from peer review and attempted to apply format from Slack Reminders Guide. Ready for review. Draft guide

ExperimentsInHonesty commented 3 years ago

@ktjnyc @Olivia-Chiong I left notes on this doc, mostly for Katie, but one for Olivia. Also, I noticed that it has a last updated date. I think we should add that to the template.

ktjnyc commented 3 years ago

Addressed and closed out all but 2 comments:

Outline color - did you want that to use the same HfLA color scheme or the orange in the guide template?
Is there a pull request guide/documentation from the DEV CoP that we can refer to? Might be better to have that as a separate guide linked in instead of buried within this guide

ExperimentsInHonesty commented 3 years ago

@ktjnyc I think it's a great idea to have how to make a pr into its own guide. And specifically how to do a pr using github visual interface. There is not one now, and the community of practice for dev's is not mature enough to take this on

ExperimentsInHonesty commented 3 years ago

@ktjnyc Outline color: I mentioned that I thought we should ask the UI/UX community of practice to weigh in on the red vs yellow highlights. Did you do talk to them about adding that to the agenda? Pull Request guide: Can you pull that out of this doc, and put it into a new guide draft doc and link to that. It dosen't have to be perfect, it just needs to be the start of it.

ktjnyc commented 3 years ago

@ExperimentsInHonesty 1 - I talked to Danielle this week and it's on the agenda for next week 2 - I pulled the PR info out into a new HOW TO for PMs and linked into this doc.

SaashaG commented 3 years ago

For devs adding this guide to the Toolkit page: the guide card Illustration and image credit information is in the Toolkit page Figma file (blue rectangle on bottom left)

Illustration name: Checklist Link: https://www.freepik.com/free-vector/checklist-concept-illustration_5573507.htm

ExperimentsInHonesty commented 3 years ago

@ktjnyc we did settle on using the yellow. Here is a guide with a guide to how to add screenshots to your guides

ExperimentsInHonesty commented 3 years ago

It looks like katie is updating this issue. I see one screenshot has been remade. I'll check back next week.

ExperimentsInHonesty commented 3 years ago

@ktjnyc Thanks for updating the images. I changed what happens when people click on the template issue, now it forces them to make a copy. Can you replace the screen shot and instructions for that part. There is a comment in the issue.

ExperimentsInHonesty commented 3 years ago

@ktjnyc I know you are super busy. Do you want me to have someone else pickup on this issue?

ExperimentsInHonesty commented 3 years ago

@ktjnyc I know you are super busy. Do you want me to have someone else pickup on finishing this guide?

ktjnyc commented 3 years ago

The last item has been updated

fchan218 commented 3 weeks ago

Prior version of issue

### Overview Product Managers need a guide to assist with writing a One Sheet so that all One Sheets follow a similar formula and contain all the necessary pieces of information regarding a project. ### Action Items Draft instructions for how to write a One Sheet for projects that don't have one yet - [x] Gather examples of how other projects have done, adding each example as a link in the resources section - [x] Once done, remove the "TG: Gather Examples" label and add the "TG: Draft Template" label - [x] Create a draft template, in a google doc - [x] Once done, remove the "TG: Draft Template" label and add the "TG: Create Guide" label - [x] Create a guide on how to use the template - [x] Once done, remove the "TG: Create Guide" label and add the "TG: Review Guide" label - [x] Review the guide with product management communities of practice - [x] Once done, remove the "TG: Review Guide" label and add the "TG: Leadership Review" label - [x] Present to Hack for LA leadership team for sign off - [ ] Once approved, remove the "TG: Leadership Review" label and add the "TG: Place Guide" label - [ ] Possibly create an issue template on .github - [ ] Include link to template under resources if you add it as a template in .github ### Resources/Instructions [Draft guide](https://docs.google.com/document/d/14-nYNCjrMrC8lucUNBfLOFQZk2sWbkRlJgigWDAlqlI/edit?usp=sharing) [Check issue hackforla/product-management#3 for sample one sheets](https://github.com/hackforla/product-management/issues/3) [One Sheet Template](https://docs.google.com/document/d/1BCNkA3cEox1qp2803r1uDAtffEszQ2P34ZDHo4dKM0Y/edit?usp=sharing)

fchan218 commented 3 weeks ago

Assignee, Labels, Project Board Placement, and Milestones for this issue in the Product Repo:

Screenshot 2024-10-18 at 3 27 08 PM

fchan218 commented 3 weeks ago

@Olivia-Chiong @ktjnyc This guide issue is moving to the knowledgebase-content repo. If you would like to maintain edit access to the issue and its associated files, please fill out the Google Drive Access Form.

fchan218 commented 3 weeks ago

Files in this issue:

Draft guide
- This file will need to be moved to the knowledgebase-content Google Drive
- Unable to move this document to the knowledgebase-content Google Drive
One Sheet Template
- This file will need to be moved to the knowledgebase-content Google Drive
- Unable to move this document to the knowledgebase-content Google Drive

hackforla / knowledgebase-content