Teknologi - Drawio, Markdown
Verktøy - Dokumentasjon, Arkitektur
- Ryddet opp i arkitekturdokumentasjonen slik at den er lettere å navigere i.
- Oppdatert system- og verktøy-diagrammer fra Mermaid til Drawio slik at de stemmer med hvordan koden ser ut.
- Standardisert dokumentasjon av prosjektstrukturen i
README og architecture.md. - Fjernet gammel og utdatert dokumentasjon som bare skapte forvirring.
Jeg er fornøyd med innsatsen i dag.
Utfordring & Løsning
Dokumentasjonen hadde begynt å bli litt utdatert, og det var vanskelig å få et raskt blikk på hvordan systemet hadde blitt bygget opp.
Målet var å forbedre strukturen i dokumentasjonen, og flytte over til å bruke Drawio isteden for Mermaid for å oppnå bedre kontroll over oversiktene.
- Ved å flytte diagrammene fra Mermaid til Drawio, har jeg fått bedre kontroll på kart-oversikten over systemet.
- Jeg har gått over den interne dokumentasjonen for å sikre at den reflekterer strukturen som er i dag.
- Ved å fjerne gamle dokumenter står jeg igjen med en mye mer presis dokumentasjonsbase.
Dette arbeidet har redusert støy når en utvikler skal forstå hvordan backend- og frontend-systemene spiller sammen. Det gir en helt annen trygghet i utviklingsarbeidet når dokumentasjonen er oppdatert til å reflektere hvordan systemet er satt sammen.
Jeg erfarte det å visualisere arkitektur med Drawio istedenfor Mermaid gir en mer organisert og ryddig struktur.
