hackforla / hackforla/HomeUniteUs
Content: Create Communication Style Guide.
- Dominant language
- Python
- Stars
- 45
- Forks
- 22
- Avg merge
- 15d 1h
- Merged PRs (30d)
- 1
Description
### Overview
We need a style guide to ensure communications fit a consistent project brand for Home Unite Us based on S.P.Y. branding guidelines.
### Action Items
#### Define the Purpose and Scope
- [ ] Align with product and brand goals: What do you want this guide to achieve?
- [ ] Decide whether it will focus on UI content, all product communications, or include marketing/support.
- [ ] Identify the primary audience for the guide (e.g., UX writers, designers, engineers).
#### Gather Existing Resources
- [ ] Audit current product content (buttons, tooltips, error messages, onboarding flows, etc.).
- [ ] Review any existing brand voice guidelines or marketing tone guides.
- [ ] Collect examples of good and inconsistent content from the product.
#### Define Voice and Tone
- [ ] Conduct a tone workshop with stakeholders (designers, PMs, brand team).
- [ ] Decide on the product’s voice: e.g., friendly, straightforward, empowering.
- [ ] Define how tone changes in different contexts (e.g., errors, onboarding, confirmations).
#### Create Terminology and Word Usage Standards
- [ ] Make a glossary of key product terms and define preferred usage (e.g., "Sign in" vs. "Log in").
- [ ] List jargon or technical terms to avoid.
- [ ] Establish naming conventions for features, buttons, and settings.
#### Establish Grammar, Punctuation, and Style Rules
- [ ] Choose a base style guide to adapt from (e.g., Apple Style Guide, Microsoft, Chicago Manual).
- [ ] Define preferences for:
- [ ] Sentence case vs. Title Case
- [ ] Active vs. passive voice
- [ ] Use of contractions (e.g., "you’re" vs. "you are")
- [ ] Use of emojis, abbreviations, or slang
#### Write Microcopy Guidelines
- [ ] Provide rules and examples for writing:
- [ ] Button labels
- [ ] Form fields and placeholders
- [ ] Error messages
- [ ] Empty states
- [ ] Confirmations and alerts
- [ ] Include “Do vs. Don’t” examples
#### Include Inclusive and Accessible Language Standards
- [ ] Write guidance on:
- [ ] Gender-neutral language
- [ ] Avoiding idioms and cultural bias
- [ ] Language that supports screen readers and plain language standards
#### Add Real-Life Examples
- [ ] Collect real examples from your product for:
- [ ] Good microcopy
- [ ] Strong onboarding messages
- [ ] Friendly, clear error messages
- [ ] Show before/after examples when improving clarity or tone
- [ ] Review examples
- [ ] Modify examples based on current project designs
#### Design the Guide for Usability
- [ ] Use headings, sections, and a table of contents
- [ ] Make it searchable and scannable
- [ ] Host in a central location (e.g., Notion, Confluence, Google Docs)
#### Review and Collaborate with Stakeholders
- [ ] Share draft with PMs, designers, writers, and support teams
- [ ] Gather feedback and revise sections as needed
- [ ] Align tone with brand and product values
#### Launch and Share the Guide
- [ ] Introduce it during a team meeting or workshop
- [ ] Walk teams through how to use it
- [ ] Embed it in your design system or content strategy toolkit
#### Maintain and Evolve the Guide
- [ ] Assign an owner (usually a UX writer or content designer)
- [ ] Set a cadence for reviewing and updating (e.g., quarterly)
- [ ] Collect feedback from the team and adapt to product evolution
- [ ] Create list of templates:
- [ ] Google Slides
- [ ] Google Doc
- [ ] Store template on project drive
- [ ] Add link on project board
### Resources/Instructions
[Communication (style) Guide for Document Creation - examples ](https://github.com/hackforla/knowledgebase-content/issues/27)
Contributor guide
Assessment
This issue has not been assessed yet.