Question marks

Highlight: Use question marks sparingly.

Use questions sparingly. Documentation is supposed to provide the readers with information rather than asking questions.

You can ask questions from the reader’s point of view. Also, it is acceptable to use questions in quoted text from user interface elements, FAQs, or reader questions.

Examples

Not recommended: Did you forget your password?

Recommended: If you forgot your password, follow these steps.

Recommended: What does it mean if I see a message saying: “Error Code 345. Do you want to continue?”

s
search
c
compose new post
r
reply
e
edit
t
go to top
j
go to the next post or comment
k
go to the previous post or comment
o
toggle comment visibility
esc
cancel edit post or comment