{ "@context":[ "https://www.w3.org/ns/activitystreams", {"Hashtag":"as:Hashtag"} ], "published":"2025-07-24T17:41:45.086Z", "attributedTo":"https://k.matthias.org/actors/relistan", "to":["https://www.w3.org/ns/activitystreams#Public"], "cc":["https://k.matthias.org/actors/relistan/followers"], "content":"
I got two AI agents, Claude and Gemini, to help generate a doc for new developers on how to work with one of our services. In the end, I am quite pleased with what it did.
Example:# Developer's Guide to the User-Profile Service
Welcome! This document is the comprehensive guide for developers working on the
User-Profile service. It outlines our architecture, established patterns, and
development workflow. Adhering to these conventions is key to maintaining a
clean, consistent, and scalable codebase.
## Table of Contents
1. [**Getting Started: Your First 5 Minutes**](#getting-started-your-first-5-minutes)
2. [**Core Architectural Principles**](#core-architectural-principles)
3. [**Codebase Tour**](#codebase-tour)
4. [**Quick Decision Guides**](#quick-decision-guides)
5. [**The Golden Path: Adding a New Feature**](#the-golden-path-adding-a-new-feature)
6. [**Deep Dive: Key Patterns & Conventions**](#deep-dive-key-patterns--conventions)
- [The Data Layer (`stores/`)](#the-data-layer-stores)
- [Event Handling (`event_consumer/`)](#event-handling-event_consumer)
- [Command Handling (`command_consumer/`)](#command-handling-command_consumer)
- [The API Layer (`webapi/`)](#the-api-layer-webapi)
- [Error Handling Patterns](#error-handling-patterns)
- [Testing (`*_test.go`)](#testing-_testgo)
- [Long-Running Tasks (`temporal/`)](#long-running-tasks-temporal)
- [Observability Best Practices](#observability-best-practices)
- [Configuration Management](#configuration-management)
- [Performance Considerations](#performance-considerations)
- [Cross-Cutting Concerns](#cross-cutting-concerns)
7. [**Development Cheatsheet**](#development-cheatsheet)
8. [**Glossary of Terms**](#glossary-of-terms)