Create " Documentation" rules for Housekeeping section of the Kit

[khanhcao17]

Overview

Work with content design to research and create a page guiding designers on best practice for creating housekeeping recommendations about how to document their process for their Figma files.

Action Items

Creating a quick guide on "documentation Housekeeping recommendations" for other designers.

• Research
  • [x] 1/26/2023 @liz-zheng
  • [x] 2/9/2023 @liz-zheng
• Working with Content
• Design
  • [x] 2/2/2023 @liz-zheng
  • [x] 2/9/2023 @liz-zheng
  • [ ] [Insert updated date and name of designer + comment date, a screenshot, and note any changes]
• Research - Usability Tests
  • [ ] [Insert updated date + comment date and any results]

Resources/Instructions

Figma file HfLA Figma Kit

[allthatyazz]

• @liz-zheng Please review #470. I added context information such as links to our previous research.

[khanhcao17]

1/26/2023

[liz-zheng]

2/9/2023

https://docs.google.com/document/d/1rDj3Vu7FWTEoFVZYSZfB9FOO_712saUpE70NWpgNO_c/edit?usp=sharing

[liz-zheng]

2/2/2023

I thought it would be helpful to provide a step by step guide, with visual aids on how to setup documentation for an existing project, with a focus on naming conventions and managing iterations visually.

[liz-zheng]

2/9/2023

Changes:

• removed step by step guide and created separate sections for documentation concerns with regards to the page layout and note content
• Did some research into existing projects and made note of what can be improved and incorporated that into the designs

• Provide examples to show how each guideline can be implemented

  

[allthatyazz]

• During one of the PM CoP meetings, I asked other PMs how the designers on their team document their process. @liz-zheng please see the notes here https://github.com/hackforla/product-management/issues/131#issuecomment-1414849746. Some of the information might be helpful.

[liz-zheng]

Changes:

Added more bullet points for designer and developer notes section after interviewing Flora Osmond from Home Unite Us project about pain points