Skriv issues og før/efter-opdateringer kort og menneskeligt #36

De seneste issues og afleveringer er svære at forstå. Lange forklaringer, internt agentsprog og mange referencer skjuler, hvad der faktisk er blevet bedre.

Forklar ændringen som til en kollega: “Jeg har ændret X, så du nu kan Y. Før skete dette; nu sker dette.”

• Brug almindeligt sprog og konkrete handlinger og resultater. Læseren skal kunne forstå forbedringen uden at åbne links.
• Vis et rigtigt før-billede og derefter et efter-billede, når en synlig ændring bedst forklares sådan. Andre ændringer kan bruge et kort eksempel.
• Skriv kort, hvad der er testet, og hvad der eventuelt mangler. Gem logs, hashes, tilladelsesdetaljer og lange rapporter bag få valgfrie links.
• Genbrug og skærp den eksisterende før/efter-vejledning. Ingen ny rapport, obligatorisk skabelon eller ekstra godkendelsesrunde.

Brug AIOS’ eksisterende Build-handoff og human-writing som inspiration. Vis forbedringen på en rigtig issue eller aflevering, og lad review kontrollere, at teksten er forståelig, korrekt og fri for unødvendigt fagsprog.