Vale CMS Need more than a rule playground? Explore

Company

Datadog documentation style guide

26 rules across 1 topics, naming 261 terms.

  • 9 errors
  • 15 warnings
  • 2 suggestions
The guide
github.com
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 avoid

The word list

Every term this guide’s rules name, and what it says to write instead.

Instead ofWrite
a number offew
acknowledgementacknowledgment
action onact on
afterwardsafterward
Amazon App MeshAWS App Mesh
Amazon App RunnerAWS App Runner
Amazon AppSyncAWS AppSync
Amazon BackupAWS Backup
Amazon Certificate ManagerAWS Certificate Manager
Amazon CloudHSMAWS CloudHSM
Amazon CloudTrailAWS CloudTrail
Amazon CodeBuildAWS CodeBuild
Amazon CodeDeployAWS CodeDeploy
Amazon Compute OptimizerAWS Compute Optimizer
Amazon ConfigAWS Config
Amazon Database Migration ServiceAWS Database Migration Service
Amazon Direct ConnectAWS Direct Connect
Amazon DMSAWS DMS
Amazon Elastic BeanstalkAWS Elastic Beanstalk
Amazon FargateAWS Fargate
Amazon Global AcceleratorAWS Global Accelerator
Amazon GlueAWS Glue
Amazon IoTAWS IoT
Amazon Key Management ServiceAWS Key Management Service
Amazon KMSAWS KMS
Amazon LambdaAWS Lambda
Amazon Network FirewallAWS Network Firewall
Amazon OpsWorksAWS OpsWorks
Amazon PrivateLinkAWS PrivateLink
Amazon Security HubAWS Security Hub
Amazon ShieldAWS Shield
Amazon Step FunctionsAWS Step Functions
Amazon Storage GatewayAWS Storage Gateway
Amazon Transit GatewayAWS Transit Gateway
Amazon Trusted AdvisorAWS Trusted Advisor
Amazon Verified AccessAWS Verified Access
Amazon VPNAWS VPN
Amazon WAFAWS WAF
Amazon X-RayAWS X-Ray
App AnalyticsTracing without Limits™
Application Programming InterfaceAPI
Artificial IntelligenceAI
Availability Zoneavailability zone
Availability Zonesavailability zones
AWS API GatewayAmazon API Gateway
AWS AppStreamAmazon AppStream
AWS AthenaAmazon Athena
AWS BedrockAmazon Bedrock
AWS CloudFrontAmazon CloudFront
AWS CloudSearchAmazon CloudSearch
AWS CloudWatch Network MonitorAmazon CloudWatch Network Monitor
AWS CodeWhispererAmazon CodeWhisperer
AWS CognitoAmazon Cognito
AWS ConnectAmazon Connect
AWS DocumentDBAmazon DocumentDB
AWS DynamoDBAmazon DynamoDB
AWS DynamoDB AcceleratorAmazon DynamoDB Accelerator
AWS EBSAmazon EBS
AWS EC2Amazon EC2
AWS EC2 Auto ScalingAmazon 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