Company
Datadog documentation style guide
26 rules across 1 topics, naming 261 terms.
- 9 errors
- 15 warnings
- 2 suggestions
- The guide
- github.com
- Rules from
- DataDog/datadog-vale
- Read at
- cda4e71
- License
- Apache-2.0
- Used by
- 1 of 355 public configs
The guide, by topic
Select a rule to see what it asks for.
Word choice
26 rules · preferred terms, jargon, and words to avoidTrademarks 4 abbreviations 31 abbreviations_latin 2 americanspelling 6 app_links 3 autodiscovery 3 aws 109 dashes endash gender 8 headings id_placeholder inclusive 4 links 8 lists merge_conflict oxfordcomma pronouns 11 quotes 4 recommendations 2 sentencelength spaces tense 5 time 3 words_case_insensitive 167 words_case_sensitive 56
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| a number of | few | |
| acknowledgement | acknowledgment | |
| action on | act on | |
| afterwards | afterward | |
| Amazon App Mesh | AWS App Mesh | |
| Amazon App Runner | AWS App Runner | |
| Amazon AppSync | AWS AppSync | |
| Amazon Backup | AWS Backup | |
| Amazon Certificate Manager | AWS Certificate Manager | |
| Amazon CloudHSM | AWS CloudHSM | |
| Amazon CloudTrail | AWS CloudTrail | |
| Amazon CodeBuild | AWS CodeBuild | |
| Amazon CodeDeploy | AWS CodeDeploy | |
| Amazon Compute Optimizer | AWS Compute Optimizer | |
| Amazon Config | AWS Config | |
| Amazon Database Migration Service | AWS Database Migration Service | |
| Amazon Direct Connect | AWS Direct Connect | |
| Amazon DMS | AWS DMS | |
| Amazon Elastic Beanstalk | AWS Elastic Beanstalk | |
| Amazon Fargate | AWS Fargate | |
| Amazon Global Accelerator | AWS Global Accelerator | |
| Amazon Glue | AWS Glue | |
| Amazon IoT | AWS IoT | |
| Amazon Key Management Service | AWS Key Management Service | |
| Amazon KMS | AWS KMS | |
| Amazon Lambda | AWS Lambda | |
| Amazon Network Firewall | AWS Network Firewall | |
| Amazon OpsWorks | AWS OpsWorks | |
| Amazon PrivateLink | AWS PrivateLink | |
| Amazon Security Hub | AWS Security Hub | |
| Amazon Shield | AWS Shield | |
| Amazon Step Functions | AWS Step Functions | |
| Amazon Storage Gateway | AWS Storage Gateway | |
| Amazon Transit Gateway | AWS Transit Gateway | |
| Amazon Trusted Advisor | AWS Trusted Advisor | |
| Amazon Verified Access | AWS Verified Access | |
| Amazon VPN | AWS VPN | |
| Amazon WAF | AWS WAF | |
| Amazon X-Ray | AWS X-Ray | |
| App Analytics | Tracing without Limits™ | |
| Application Programming Interface | API | |
| Artificial Intelligence | AI | |
| Availability Zone | availability zone | |
| Availability Zones | availability zones | |
| AWS API Gateway | Amazon API Gateway | |
| AWS AppStream | Amazon AppStream | |
| AWS Athena | Amazon Athena | |
| AWS Bedrock | Amazon Bedrock | |
| AWS CloudFront | Amazon CloudFront | |
| AWS CloudSearch | Amazon CloudSearch | |
| AWS CloudWatch Network Monitor | Amazon CloudWatch Network Monitor | |
| AWS CodeWhisperer | Amazon CodeWhisperer | |
| AWS Cognito | Amazon Cognito | |
| AWS Connect | Amazon Connect | |
| AWS DocumentDB | Amazon DocumentDB | |
| AWS DynamoDB | Amazon DynamoDB | |
| AWS DynamoDB Accelerator | Amazon DynamoDB Accelerator | |
| AWS EBS | Amazon EBS | |
| AWS EC2 | Amazon EC2 | |
| AWS EC2 Auto Scaling | Amazon EC2 Auto Scaling |
These rules run in Vale, which checks a whole documentation set against a guide in your editor and on every pull request.
All 16 guides