Report docs issues with route-ready context.

Use these copy-ready templates for missing docs, incorrect docs, example problems, compatibility mismatches, and product questions. Public readers should use approved support or community channels. Employees with source access can paste the same fields into the internal tracker.

Choose A Template

Docs lead first, then product SME if product behavior is named.
Missing docs
A page, section, prerequisite, glossary term, or workflow does not exist or is too hard to find.
Product SME for behavior, docs QA for route and evidence checks.
Incorrect docs
A public page appears stale, incomplete, misleading, or inconsistent with another published route.
Docs QA and the product owner for the affected example.
Example issue
A command, SDK snippet, expected output, cleanup step, or sample artifact needs review.
Product SME, docs lead, and compatibility reviewer.
Compatibility report
A status row, maturity label, supported/unsupported note, or version/profile statement looks wrong.
Support triage first, then docs or product owner when docs need a follow-up.
Product question
A reader cannot decide which product, route, limit, or status page answers their task.

Copy Templates

Paste the matching block into the approved public intake channel or the internal employee issue tracker. Leave unknown fields blank instead of guessing.

Text

Missing docs

Use when the docs do not cover a reader task or the right page cannot be found.

Docs issue type: Missing docs
Product: ObjectDB | Message Broker | Concordia | LogDB | Cross-product
Public route or page title:
Reader goal:
What is missing:
Expected docs outcome:
Content type: overview | quickstart | tutorial | guide | reference | compatibility | limits | runbook | evidence | community
Claim, limit, status, example, or support impact:
Evidence, screenshot, or public source:
Reporter context:
Sensitive details removed: yes | no | not applicable

Text

Incorrect docs

Use when a published statement appears wrong, stale, unclear, or stronger than the evidence supports.

Docs issue type: Incorrect docs
Product: ObjectDB | Message Broker | Concordia | LogDB | Cross-product
Public route:
Current statement or section:
Why it looks incorrect:
Expected correction:
Content type:
Evidence available to reviewer:
Affected maturity label, status row, limit, example, or support workflow:
Reviewer roles likely needed:
Sensitive details removed: yes | no | not applicable

Text

Example issue

Use when a command, code snippet, expected output, sample file, or cleanup step needs docs review.

Docs issue type: Example issue
Product: ObjectDB | Message Broker | Concordia | LogDB | Cross-product
Example route:
Command, snippet, or sample artifact:
Observed output or confusion:
Expected output or reader outcome:
Environment or profile:
Validation attempted:
Cleanup or data impact:
Reviewer-run rationale when local reproduction is not available:
Sensitive details removed: yes | no | not applicable

Text

Compatibility report

Use when a compatibility row, maturity label, version, profile, or unsupported-behavior note needs review.

Docs issue type: Compatibility report
Product: ObjectDB | Message Broker | Concordia | LogDB
Public route:
Surface, version, profile, or deployment mode:
Current compatibility or maturity statement:
Observed mismatch:
Expected status or boundary:
Evidence available to reviewer:
Risk if the docs stay unchanged:
Reviewer roles likely needed:
Sensitive details removed: yes | no | not applicable

Text

Product question

Use when the reader question may need a docs answer before it becomes a product support request.

Docs issue type: Product question
Product: ObjectDB | Message Broker | Concordia | LogDB | Cross-product
Reader question:
Public routes checked:
Decision blocked:
Content type that should answer this:
Current workaround or next best route:
Claim, limit, compatibility, or support impact:
Suggested owner or reviewer role:
Sensitive details removed: yes | no | not applicable

Product Routing

Product routing for docs issue intake
Product	Use when the issue mentions	Owner	Reviewers
ObjectDB	The issue names S3 Core behavior, bucket/object workflows, native API preview wording, storage limits, or ObjectDB evidence.	storage docs owner	ObjectDB product SME and docs QA reviewer.
Message Broker	The issue names streams, replay, cursors, queues, HTTP routes, CLI/SDK wording, audit, metrics, or broker compatibility.	broker docs owner	Message Broker product SME and docs QA reviewer.
Concordia	The issue names Cache, Gateway alpha readiness, Storage validation, Time Series shell, or active compatibility wording.	Concordia docs owner	Concordia product SME and docs QA reviewer.
LogDB	The issue names OTLP ingest, retained-record query, WAL, segment bundles, S3 query-read, BYOC boundaries, or LogDB evidence.	observability docs owner	LogDB product SME and docs QA reviewer.
Cross-product	The issue spans status, search, navigation, glossary, roadmap, examples, contribution flow, page health, or shared limits.	docs-product-lead	Docs lead, support reviewer, or product SME based on the named product area.

Content-Type Routing

Content-type routing for docs issue intake
Content type	Use when	Reviewers
Missing, wrong, or unclear overview content	The issue changes how a reader chooses a product, understands maturity, or finds the next route.	Docs lead; product SME when product behavior is described.
Quickstart, tutorial, snippet, or example	The issue changes commands, SDK calls, expected output, prerequisites, cleanup, or validation notes.	Docs QA reviewer and product SME.
Reference, configuration, compatibility, or limits	The issue changes route contracts, flags, config keys, status rows, unsupported behavior, or evidence links.	Product SME, docs QA reviewer, and docs lead for limits.
Operations, support, privacy, or sensitive claims	The issue changes diagnostics, escalation, data handling, legal language, support paths, or claim-risk wording.	Support, operations, privacy, security, legal, or product reviewer as triggered by the issue.
Community, roadmap, search, or navigation	The issue changes public contribution expectations, planning summaries, search facets, or route discoverability.	Docs-product lead and docs platform reviewer.

Intake Boundaries

Use public routes, not private paths

Name the docs URL, heading, or product area. Employees with repository access can add internal paths after triage.

Keep product bugs separate

If the product behavior itself is broken, route it through the approved support or product channel and file a docs issue only for the documentation gap.

Redact before sharing

Remove credentials, customer identifiers, payload bodies, private topology, logs that reveal secrets, and unpublished implementation details.

Flag claim risk early

Call out any availability, durability, performance, privacy, support, compatibility, or security-sensitive wording so reviewers can route it correctly.