Skip to content

Update style-guide.md for AI Chatbots #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 28, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions templates/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<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. |
| 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. \<br>Avoid phrases such as "NGINX Plus allows you to…". \<br><br>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. \<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. | |
Expand Down
Loading