Skip to main content

What are the best practices for naming and documentation?

DNS documentation best practices:

Record naming:

Clear purpose in subdomain names (mail., tracking., selector1._domainkey.)

Consistent conventions across domains

Avoid cryptic abbreviations

Documentation content:

What each record does

Who is responsible for it

When it was created/modified

Why it exists (context)

Dependencies (what breaks if removed)

Format:

Table or structured document

Linked to any related service documentation

Accessible to all relevant team members

Without documentation, DNS becomes tribal knowledge that is lost when people leave or forget.

Clear labels on every document in the registry. Anyone should understand each entry's purpose.