hackforla / hackforla/knowledgebase-content

Create a Guide/Template: Communication (style) Guide for Document Creation template/examples

Offen
#29 10 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Complexity: Missing CoP label: checked CoP label: shortcuts added CoP: Design CoP: Marketing CoP: Product CoP: UI/UX Research feature : guide creation Folders Checked Phase: 3 - Drafting a Guide Ready for Bonnie Triage size: 2pt status: 3.1 needs draft
Vorherrschende Sprache
Keine Sprachdaten
Sterne
2
Forks
1
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### Overview
We need to create a guide to making a Communication (style) Guide for Document Creation so that the documents that come out of their projects will have a consistent look and feel that has been coordinated with HfLA org leadership to maintain brand consistency both in their project and with other projects in the portfolio.

### 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 labelled 'Tasks' at the bottom of this issue, and complete each task listed.
- [ ] [Gather Examples Solo](https://github.com/hackforla/guides/wiki/How-to-Gather-Examples:-Solo) (open in a new tab)
- [ ] [Gather Examples Collaboratively](https://github.com/hackforla/guides/wiki/Phase-2-%E2%80%90-Gather-Examples-Collaboratively)
- [ ] [Create a Guide Draft](https://github.com/hackforla/guides/wiki/How-to-Draft-a-Guide)
- [ ] If needed, create a template
- [ ] [Have your guide peer reviewed](https://github.com/hackforla/guides/wiki/Peer-Reviews-for-Guides)
- [ ] [Present your guide for leadership review](https://github.com/hackforla/guides/wiki/Submitting-Your-Guide-for-Leadership-Review)

### Resources/Instructions
Google Drive Folder for this Guide's documents and shortcuts (to documents in other locations) [0029 [DRAFT] Communication (style) Guide for Document Creation template/examples ](https://drive.google.com/drive/folders/15AhNhNjbQV6txxBdnD3deNQINMHkPQ-_)

### Projects to Check
- [100 Automations](https://github.com/100automations/website)
- Issues
- https://github.com/100Automations/Website/issues/138
- WIKI
- Instructions for how to make a guide on their website: https://github.com/100Automations/Website/wiki/Guide-to-the-Guide-Template
- template for making a guide on their website: https://github.com/100Automations/Website/wiki/guide_template.md
- [311 Data](https://github.com/hackforla/311-data)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [Access the Data](https://github.com/hackforla/access-the-data)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [BallotNav](https://github.com/hackforla/ballotnav)
- Issues https://github.com/hackforla/ballotnav/issues/435
- [Communication Guide](https://docs.google.com/presentation/d/1240MJDl2PA6NcchLwVdGvweI-dC_E4u4-V8jmHNz_LI/edit?usp=sharing)
- [Civic Tech Index](https://github.com/civictechindex/CTI-website-frontend)
- Issues
- https://github.com/civictechindex/CTI-website-frontend/issues/711
- [Civic Tech Jobs](https://github.com/hackforla/CivicTechJobs)
- Issues
- https://github.com/hackforla/CivicTechJobs/issues/152
- [Civic Tech Structure](https://github.com/hackforla/civic-tech-structure)
- [Copy](https://docs.google.com/presentation/d/1JZ2Yx7zpTfo6VfMhptjSuva45vBEWV-U6DvNbyPzCYM/edit?usp=sharing)
- [Data Science Projects](https://github.com/hackforla/data-science)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [Design Systems](https://github.com/hackforla/design-systems)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [Engage](https://github.com/hackla-engage)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [Expunge Assist](https://github.com/hackforla/record-clearance)
- [Communication Guide](https://docs.google.com/presentation/d/1xHpTqWVNqsfYcFBVN1Yqo7G-tDEKQ55tRsOnDdS6mXk/edit?usp=sharing)
- [Food Oasis](https://github.com/hackforla/food-oasis)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [GreenEarthOS](https://github.com/hackforla/climate-project)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [Guides](https://github.com/hackforla/guides)
- Issue https://github.com/hackforla/product-management/issues/60
- [Doc 1](https://docs.google.com/presentation/d/1DV1nDhB6BvZUpSZqSN2ldDRE8lVIoaNAd97FgJhsf3E/edit#slide=id.g8078b36bb8_0_35)
- [Doc 2](https://docs.google.com/presentation/d/1JBIH9TkL5qdB2CNRllPB3vxWjjUkVOXL_-21JgshmCc/edit#slide=id.g105dd03c64c_1_87)
- [HomeUniteUs](https://github.com/hackforla/homeuniteus)
- Issues
- https://github.com/hackforla/HomeUniteUs/issues/315
- [Internship](https://github.com/hackforla/internship)
- [Communications Guide](https://docs.google.com/presentation/d/1u_rAQx9wz7_2XT3mL1zAu1mtUXvds8YNlbMb-cxDGTI/edit?usp=sharing) - WIP
- [Lucky Parking](https://github.com/hackforla/lucky-parking)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [Open Community Survey](https://github.com/hackforla/open-community-survey)
- [Communication Guide](https://docs.google.com/presentation/d/1V_JVpqLadtYUQDdDfVUmYmgt-nCfvz_tNTFkWmbNeG0/edit#slide=id.ge8a45a6c42_0_4) - mostly done and a good example
- [People Depot](https://github.com/hackforla/peopledepot)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [TDM Calculator](https://github.com/hackforla/tdm-calculator)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [VRMS](https://github.com/hackforla/vrms)
- None as of 2022-04-07
- I checked Issues, wiki and slack channels
- [Hack for LA's Website](https://github.com/hackforla/website)
- None as of 2021-09-1
- [Youth Justice Nav](https://github.com/hackforla/YouthJusticeNav)
- Issues
- https://github.com/hackforla/YouthJusticeNav/issues/63

#### External projects (with finished communication guides)
[BOP Communications Guide for Document Creation](https://docs.google.com/presentation/d/1uIRCQXKmOYifAhGOQArK0JMmlksE7U4KvuMN0Be11-0/edit#slide=id.g94b7b777b5_0_0)
[Copy of Get Your Refund Communications Guide for Document Creation](https://docs.google.com/presentation/d/1b67e6ubqqKgFTf7l1A9srHDrCEIk5kprRf9JldS5RNI/edit#slide=id.g8078b36bb8_0_35)

### Communities of Practice
- UI/UX community of practice
- None as of 2021-09-1
### Tasks
- [ ] This is where you will copy instructions from the wiki page for the step you are currently on.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start with the linked wiki instructions for gathering examples, drafting, peer review, and leadership review, then inspect the Google Drive folder and the communication-guide examples listed in the issue. Complete the phases and populate the Tasks section as instructed; done means a reviewed Communication Guide for Document Creation template/examples is produced and submitted for leadership review.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.