Skip to content

Commit 6d2ce1f

Browse files
authored
Update style-guide.md for AI Chatbots (#612)
Always use "F5 AI Assistant"
1 parent 2193eed commit 6d2ce1f

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

templates/style-guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ The table provides guidelines about the terms you should and should not use for
6464
| abort | Never use this term in your docs. Use the preferred terms when writing about a process:<br>stop<br>interrupt<br>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. |
6565
| above and below | Avoid. Refer to the specific section, table, figure, an so on, as opposed to indicating its relative position in the document. | |
6666
| access | Used as a verb, it's jargon, so don't use it.| |
67+
| AI Chatbot | The official name for any F5 chatbot: "F5 AI Assistant" | |
6768
| allows | Not recommended. \<br>Avoid phrases such as "NGINX Plus allows you to…". \<br><br>Use direct, active verbs from the perspective of the user instead. | |
6869
| 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. | |
6970
| anthropomorphism | Avoid referring to the product or feature as though it were alive. \<br>When referring to products, stay away from words like: decides, knows, sees, listens, and hears.<br>A wizard guides you, it doesn't walk you through the steps. | |

0 commit comments

Comments
 (0)