From dfab45c22165299d919cca00ecfcb4c3e04201df Mon Sep 17 00:00:00 2001
From: Mike Jang <3287976+mjang@users.noreply.github.com>
Date: Tue, 27 May 2025 12:47:10 -0700
Subject: [PATCH] Update style-guide.md for AI Chatbots
Always use "F5 AI Assistant"
---
templates/style-guide.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/templates/style-guide.md b/templates/style-guide.md
index 4959228fd..0b229717c 100644
--- a/templates/style-guide.md
+++ b/templates/style-guide.md
@@ -64,6 +64,7 @@ The table provides guidelines about the terms you should and should not use for
| abort | Never use this term in your docs. Use the preferred terms when writing about a process:
stop
interrupt
shut down | Abort is acceptable to use in programmer or similar technical documentation only if it is a function name, parameter name, or otherwise part of a name in the API. |
| above and below | Avoid. Refer to the specific section, table, figure, an so on, as opposed to indicating its relative position in the document. | |
| access | Used as a verb, it's jargon, so don't use it.| |
+| AI Chatbot | The official name for any F5 chatbot: "F5 AI Assistant" | |
| allows | Not recommended. \
Avoid phrases such as "NGINX Plus allows you to…". \
Use direct, active verbs from the perspective of the user instead. | |
| and/or | Not recommended. Usually, this means either "and" or "or". Try to be specific in your writing; people are counting on you for clear instructions. | |
| anthropomorphism | Avoid referring to the product or feature as though it were alive. \
When referring to products, stay away from words like: decides, knows, sees, listens, and hears.
A wizard guides you, it doesn't walk you through the steps. | |