From 78e53324850a701555b41a068679a5f83ba44a15 Mon Sep 17 00:00:00 2001 From: apgordon312 Date: Sun, 4 May 2025 11:46:38 -0700 Subject: [PATCH] Update style-guide.md Added clarification about when to use articles in front of a product name. --- templates/style-guide.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/templates/style-guide.md b/templates/style-guide.md index d97e06a98..7dea90a3b 100644 --- a/templates/style-guide.md +++ b/templates/style-guide.md @@ -48,8 +48,11 @@ When writing documentation for our project, align with the default guide's voice - Using NGINX Plus Docker images with NGINX Instance Manager -- Don't use articles ("the", "a") in front of product names. For example, use +- Don't use articles ("the", "a") in front of product names. For example, use: - NGINX Agent (not "the NGINX Agent"). + - EXCEPTION: Use an article ("the", "a") if the product name is qualifying another noun. For example, use: + - Edit the NGINX Agent configuration file (not "Edit NGINX Agent configuration file") ← In this case, "NGINX Agent" is a descriptor for the term "configuration file". + - Expose NGINX Agent's REST API ← In this case, NGINX Agent is a standalone noun phrase, and it "possesses" the REST API. - Always use the full brand name in the meta description. The meta description does not count as first mention of the product in the document.