Feedback on this documentation
Development status: Status and changes — A public channel for feedback on this documentation has not yet been announced; this page describes how feedback would be handled once one is. Security problems are not documentation feedback: their reporting route is covered on Security assurance status and reporting problems and has not yet been announced either. Nothing described in this documentation is publicly available for live use.
Before you read: nothing — this page can be read on its own.
How can you report an error in the documentation or ask a question? A public channel has not yet been announced. This page explains what feedback would be welcome, what feedback cannot be used for, what to include, how to give feedback safely, how feedback would be handled once a channel exists and where security problems are covered.
The short answer
A public channel for documentation feedback has not yet been announced. Once one is decided, it would be given on this page and recorded in the Documentation change log. Until then, there is no route for documentation feedback.
Security problems are not documentation feedback. They are covered on Security assurance status and reporting problems, where a reporting route has also not yet been announced.
Feedback that would be welcome
- Errors or inaccuracies, and statements that appear out of date — for example, on a page past its next-review date.
- Unclear explanations, missing answers to a reader’s question and confusing examples.
- Broken or misleading links, and accessibility barriers.
- Questions about what a page means.
What feedback cannot be used for
- Requesting access to internal environments, tooling or unpublished material.
- Product support: no product has been released.
- Reporting security vulnerabilities, which would have their own route.
- Getting answers about topics this documentation does not cover; the absence of a topic is not an answer about it.
What to include once a channel exists
- The page title and address, and the as-of date shown on the page.
- The passage concerned, what you expected and, if you have one, a suggested correction.
- For accessibility barriers, how you were reading the page, such as the device or assistive technology used.
Giving feedback safely
- Do not include personal data, real keys, secrets or confidential business information.
- Do not include details of a suspected security problem, and avoid publishing such details until a reporting route is announced.
How feedback would be handled
Status of this section: Planned — this describes intended handling once a channel exists.
- Feedback would be reviewed, and corrections that change a page’s meaning would be recorded in the change log.
- Suggestions for open research questions could be considered for Assumptions and open questions.
- No response time is promised.
Assumptions, trust and limitations
The handling described above is an intention; no response or outcome is guaranteed.
Not yet available, and how this page will grow
Once a channel is decided, this page would give it, together with what to expect, and the change would be recorded in the change log.
What this page does not claim
This page does not claim that a feedback channel or a security-reporting channel exists, that any response time applies, or that support is offered for any product.
Related pages
- Security assurance status and reporting problems — where security problems are covered.
- Documentation conventions: status labels, dates and reviews — how to judge whether a page is current.
- Documentation change log — where corrections and the announcement of a channel would be recorded.
Glossary
References
No approved public references yet.
