Add naming recommendations

Closes #1785
smithy-lang · Jul 31, 2023 · 83920a8 · 83920a8
1 parent 59578f3
commit 83920a8
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/source-2.0/guides/style-guide.rst b/docs/source-2.0/guides/style-guide.rst
@@ -175,6 +175,14 @@ Shape names
 
 Shape names use a strict form of UpperCamelCase (e.g., "XmlRequest", "FooId").
 
+* Numeric shapes should use descriptive names when possible, including units
+  of measurement (e.g., prefer "SizeInMb" over "Size").
+* Enums should use a singular noun (e.g., prefer "Suit" over "Suits").
+* Lists should use plural names (e.g., prefer "Users" over "UserList").
+* Operations should follow the format of "VerbNoun" (e.g., "UpdateUser").
+* Services should be named after the name of a service, omitting
+  branding when possible (e.g., prefer "S3" over "AmazonS3").
+
 
 Member names
 ------------