Choose a question and freeze the source
Name the reader and the decision: onboarding to a service, reviewing a risky change, or finding where an incoming request reaches storage. Record the repository URL and commit, or the local working-tree changes when the source is not a clean commit. This makes the explanation reproducible.
The Agent reads the repository in your own development environment. OWL Compose does not fetch a private repository simply because you paste a URL. Do not put credentials, environment secrets or unrelated private source into the published artifact.
Trace one real path before drawing the system
Start at a concrete entry point such as an HTTP route, CLI command, queue consumer or scheduled job. Follow the calls that matter to the question. Record module names, source file paths and symbols as evidence, and distinguish an actual invocation from an inferred dependency.
Show the request direction, the data passed across each boundary, and important asynchronous steps. A package import graph alone does not establish runtime order. If behavior depends on configuration or a feature flag, state which configuration the diagram describes.
Choose a readable architecture view
Use a small flow for a single request and a grouped relationship graph when several services or layers need to be explored. Keep detailed functions near their owning module. Label edges with their meaning: calls, enqueues, reads, writes or returns. Avoid connecting every node to every dependency.
Ask the Agent to write OWX using the installed authoring Skill. Relationship diagrams support groups and interactive graph views; explanatory text and tables can sit alongside the map. Keep source references in the explanation so a reader can return to the implementation.
Validate the explanation and the rendered diagram
Compile and inspect the work at desktop and mobile widths. Follow one path from the entry point to its observable result, check that arrows match the source, and expand any graph groups needed to answer the original question. A successful compile validates structure; it does not prove architectural claims.
Before sharing, inspect the actual published work in the owner view. Works are private by default. Create an explicit reader link when the intended audience should have access. Preserve the local OWX and document identity when publishing later revisions, and update the recorded source version.
FAQ
Häufige Fragen
Does OWL Compose upload my repository?
The local Agent reads your source. Publishing sends the compiled document and its package-bound assets, so review that artifact for private content before sharing.
Can I update the architecture after a code change?
Yes. Update the same local OWX, verify the changed paths, and publish a new revision of the existing work. Repository synchronization is not automatic.
Echten Workflow nutzen
Veröffentliche, was dein Agent erschafft.
Installiere die CLI, erstelle in OWX, prüfe lokal und veröffentliche ein privates Werk. Erstelle erst beim Teilen einen Leserlink.