hackforla / hackforla/knowledgebase-content
Create a Guide/Template: Site Architecture Documentation
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 2
- Fork
- 1
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
### Overview
We need to create a guide to making Site Architecture Documentation so that New developers, stakeholders and Devops understand how the site is organized.
### 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](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) [0157 [DRAFT] Site Architecture Documentation](https://drive.google.com/drive/folders/12uJMWdsd-Zz-XGUsvkYgrYY-tykij1vI)
### Projects to Check
#### Projects to check
##### Documentation Found
- [100 Automations](https://github.com/100automations/website)
- [311 Data](https://github.com/hackforla/311-data)
- [Civic Tech Index](https://github.com/civictechindex/CTI-website-frontend)
- [Civic Tech Jobs](https://github.com/hackforla/CivicTechJobs)
- [Hack for LA's Website](https://github.com/hackforla/website)
- [Hack for LA website Architecture document](https://github.com/hackforla/website/wiki/Hack-for-LA's-Site-Architecture)
- [VRMS](https://github.com/hackforla/vrms)*
##### Documentation Not Found
- [Access the Data](https://github.com/hackforla/access-the-data)
- [BallotNav](https://github.com/hackforla/ballotnav)***
- [Brigade Organizer's Playbook](https://github.com/codeforamerica/brigade-playbook)**
- [Civic Tech Structure](https://github.com/hackforla/civic-tech-structure)
- [Data Science Projects](https://github.com/hackforla/data-science)
- [Design Systems](https://github.com/hackforla/design-systems)
- [Engage](https://github.com/hackla-engage)**
- [Expunge-Assist (formerly known as Record Clearance)](https://github.com/hackforla/expunge-assist)**
- [Food Oasis](https://github.com/hackforla/food-oasis)***
- [Guides](https://github.com/hackforla/guides)**
- [GreenEarthOS](https://github.com/hackforla/climate-project)***
- [HomeUniteUs](https://github.com/hackforla/homeuniteus)***
- [Internship project](https://github.com/hackforla/internship)**
- [Lucky Parking](https://github.com/hackforla/lucky-parking)
- [Open Community Survey](https://github.com/hackforla/open-community-survey)
- [People Depot](https://github.com/hackforla/peopledepot)
- [Tables team](https://github.com/hackforla/tables/)
- [TDM Calculator](https://github.com/hackforla/tdm-calculator)
- [Youth Justice Nav](https://github.com/hackforla/YouthJusticeNav/)**
*Only architecture for UI documented/diagrammed.
**Uses wiki draft template indicating awareness of the need for site architecture documentation
***May have information within Google Drive.
### Tasks
- [ ] This is where you will copy instructions from the wiki page for the step you are currently on.
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia dalla cartella Google Drive collegata e dal documento esistente sull’architettura del sito web di Hack for LA, quindi segui le istruzioni del wiki per raccogliere esempi, redigere il documento, svolgere la peer review e la leadership review. Il lavoro è completato quando è disponibile una guida o un modello Site Architecture Documentation completo che copra i progetti elencati, la checklist Tasks dell’issue è stata completata e la guida è stata revisionata e inviata alla leadership review.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100