How dreadwail/wiki works
Gather Source Material
• Review every wiki page that describes the system: overall architecture, component descriptions, data flows, deployment topology.
• Extract key modules or services, data stores, APIs, and any external integrations mentioned.
Project Type and Purpose
• Whether this is a web application (monolith or microservices), mobile app backend, middleware framework, library, or tooling project.
• Primary use cases (e.g., user-facing portal, batch data processing, real-time messaging).
Establish Main Components
From your wiki research, list out:
a. Frontend/UI layers (web client, mobile clients).
b. Backend services or application servers (single service or multiple microservices).
c. Data stores (relational database, NoSQL store, cache).
d. External dependencies (third-party APIs, authentication providers, messaging queues).
e. Deployment platforms (cloud services, container orchestration, on-prem).
Relationships and Interactions
• For each pair of components, determine how they communicate (REST/gRPC calls, message bus, direct DB access).
• Request/response flows and asynchronous event flows.
• Shared libraries or internal SDKs used across services.
Architectural Patterns or Principles
• If the system uses MVC, Onion Architecture, hexagonal ports/adapters, CQRS, event sourcing, note these and map them to your components.
• Load-balancing, failover, circuit breakers, or other resilience patterns.
• Where authentication, authorization, and logging/tracing fit in.
Technologies
• Database engine (PostgreSQL, MongoDB, Redis).
• Message brokers (Kafka, RabbitMQ) or CI/CD pipelines.