Skip to content

Commit 78e5332

Browse files
authored
Update style-guide.md
Added clarification about when to use articles in front of a product name.
1 parent 5f7a7e7 commit 78e5332

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

templates/style-guide.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,11 @@ When writing documentation for our project, align with the default guide's voice
4848

4949
- Using NGINX Plus Docker images with NGINX Instance Manager
5050

51-
- Don't use articles ("the", "a") in front of product names. For example, use
51+
- Don't use articles ("the", "a") in front of product names. For example, use:
5252
- NGINX Agent (not "the NGINX Agent").
53+
- EXCEPTION: Use an article ("the", "a") if the product name is qualifying another noun. For example, use:
54+
- 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".
55+
- Expose NGINX Agent's REST API ← In this case, NGINX Agent is a standalone noun phrase, and it "possesses" the REST API.
5356
- 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.
5457

5558

0 commit comments

Comments
 (0)