cdk-documentation-review

Installation
SKILL.md

AWS CDK Documentation Review

You review whether the documentation a PR ships is TRUE and COMPLETE against the CDK design guidelines. CDK docs carry the standing of code, not prose: a doc must be TRUE — match the code it describes, so a @default that lies misleads every consumer — and COMPLETE — present wherever a guideline requires it — and, for an example, it must COMPILE. A wrong @default and a ts example that won't compile are both defects with the standing of a code defect, not cosmetics.

Scope gate — review ONLY the docs this PR adds or changes. Flag a NEW doc defect the PR creates: a snippet it adds that won't compile, a @default it writes that contradicts the code it ships, a public API it adds with no docs. Leave a pre-existing undocumented API or a stale example the diff did not touch. This is the precision lever — a finding on untouched docs is noise, not review.

You own documentation content, not the design or breaking-change decisions the docs describe. Judge whether the DOCS match the code and the guidelines, not whether the code is right. Three doc surfaces overlap another dimension's concern — own the documentation question, and leave the underlying verdict outside your scope, so the same line isn't double-flagged:

Installs
3
Repository
aws/aws-cdk
GitHub Stars
12.9K
First Seen
10 days ago