Documentation Audiences
The public docs should be useful to customers, developers, workspace administrators, and operators without exposing private operational details.
Public Documentation
Public pages should explain what Veoveo does, how workflows behave, how APIs are used, what tools require, and how teams operate the product. They should be clear enough for a new user to learn the product and precise enough for a developer to start integrating.
Good public content includes:
- product concepts and workflows
- app navigation and user tasks
- artifact and tool behavior
- API route groups, examples, and schema links
- operational practices that do not expose private configuration
- media placeholders for planned screenshots, diagrams, tables, and videos
Private Operational Detail
Some information belongs outside public documentation: credentials, private callback payloads, deployment-only identifiers, incident notes, unreleased implementation details, and environment-specific runbooks. Public docs can describe the behavior and safety model without publishing those details.
Writing Standard
A public page should answer a reader's question directly. Avoid pages that only describe the documentation process, implementation migration status, or maintenance checklist. If a page exists in the public docs, it should help someone use, integrate, administer, or operate Veoveo.
Media To Add
- Diagram: audience map showing users, admins, developers, and operators with the doc sections each group should read. It helps teams choose the right path. Source: docs navigation and role-based onboarding plan.