LLM-Friendly Documentation
Authoring rules for Markdown, code blocks, and diagrams so external AI systems retrieve Obtrace docs correctly.
LLM-Friendly Documentation
Write each page as a canonical answer to one engineering question. The first paragraph must define the concept, when to use it, and the operational outcome.
Required section order
- Overview
- Prerequisites
- Install or Configure
- Verify
- Troubleshooting
- Security
- Related pages
Code block rules
- Always use an explicit language tag.
- Add one line before the code explaining what the command does.
- Add expected output when the command proves success.
Diagram rules
- Prefer Mermaid.
- Add a short paragraph below each diagram summarizing the flow in plain language.
- Use stable node names such as
Obtrace Agent,Signal Correlator,Policy Engine, andPull Request Bot.