Create a Guide/Template: Site Architecture Documentation

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 (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

Google Drive Folder for this Guide’s documents and shortcuts (to documents in other locations) 0157 [DRAFT] Site Architecture Documentation

Projects to Check

Projects to check

Documentation Found

• 100 Automations
• 311 Data
• Civic Tech Index
• Civic Tech Jobs
• Hack for LA's Website
  • Hack for LA website Architecture document
• VRMS*

Documentation Not Found

• Access the Data
• BallotNav***
• Brigade Organizer's Playbook**
• Civic Tech Structure
• Data Science Projects
• Design Systems
• Engage**
• Expunge-Assist (formerly known as Record Clearance)**
• Food Oasis***
• Guides**
• GreenEarthOS***
• HomeUniteUs***
• Internship project**
• Lucky Parking
• Open Community Survey
• People Depot
• Tables team
• TDM Calculator
• Youth Justice Nav**

*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.

Beginnen Sie mit dem verlinkten Google Drive-Ordner und dem vorhandenen Dokument zur Website-Architektur von Hack for LA. Befolgen Sie anschließend die Wiki-Anweisungen zum Sammeln von Beispielen, zum Erstellen eines Entwurfs, zur Peer-Review und zur Überprüfung durch die Leitung. Abgeschlossen ist die Aufgabe, wenn ein vollständiger Site Architecture Documentation-Leitfaden oder eine entsprechende Vorlage für die aufgeführten Projekte vorliegt, die Tasks-Checkliste des Issues abgeschlossen ist und der Leitfaden geprüft und zur Überprüfung durch die Leitung eingereicht wurde.