Documentation feedback
Goal: a project owner or client must be able to mark a concrete part of the documentation and explain why it is inaccurate, untrusted, unclear, or insufficient.
Proposed flow
Section titled “Proposed flow”sequenceDiagram participant Reader as Documentation reader participant UI as Docs UI participant Store as Feedback store participant Owner as Area owner participant Agent as AI/docs agent Reader->>UI: Select paragraph or text UI->>Store: Store doc_path, block_id, selection, comment Store->>Owner: Create review item Owner->>Store: Add verdict or context Agent->>Store: Load open feedback Agent->>UI: Propose documentation update
Minimal data
Section titled “Minimal data”| Field | Why |
|---|---|
doc_path | Where the issue appeared. |
block_id | Stable paragraph or section identifier. |
selected_text | What the reader challenged exactly. |
comment | Why the text is a problem. |
reason | Factual error, unclear text, distrust, missing detail, other. |
audience | Client, internal team, developer, integrator. |
source_commit | What the text was verified against, if known. |
Implementation note
Section titled “Implementation note”GitHub issues may be enough for internal feedback. For clients, a custom store or a small backend endpoint is better because clients should not need GitHub accounts.