From a30227898794108b391694eafaf0f78482371509 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Tue, 30 Apr 2024 15:29:53 -0700 Subject: [PATCH] contributor docs: Extend help center writing style documentation. --- docs/documentation/helpcenter.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/documentation/helpcenter.md b/docs/documentation/helpcenter.md index a58192f0a8..ed42389122 100644 --- a/docs/documentation/helpcenter.md +++ b/docs/documentation/helpcenter.md @@ -213,7 +213,17 @@ feature's name followed by the feature itself (e.g. **Settings** page, used. Use **bold** for stream names, and quotation marks for topic names. Keep in mind that the UI may change — don’t describe it in more detail than -is needed. **Never identify or refer to a button by its color.** +is needed. In particular: + +- Do not specify what the default configuration is. This might change in the + future, or may even be different for different types of organizations. +- Do not list out the options the user is choosing from. Once the user finds the + right menu in the UI, they'll be able to see the options. In some cases, we + may describe the options in more detail outside of the instructions block. +- Never identify or refer to a button by its color. You _can_ describe its + location. +- Use screenshots only when it's very difficult to get your point across without + them. ### Voice