Add a docs writing standard to CLAUDE.md

[dmontagu]

Adds a "Writing standard" subsection under the Documentation section of CLAUDE.md, holding every page in the public docs to one standard: a reader who is an expert in their own field but new to observability should be able to understand it.

Concretely, the checklist asks that:

• acronyms are spelled out at first use on each page,
• every page opens with what it's for and why you'd use it,
• copy describes the user's goal rather than our internals,
• instructions say where to run or fetch things, and
• consequences (data leaving the machine, cost, irreversibility) are stated plainly.

The point is introducing precise terms with a plain-language hand-hold at first use, not avoiding them. The standard is scoped to docs prose — docstrings and other in-code text follow normal API-reference conventions.

https://claude.ai/code/session_01VRXHUAwM4RjifoaouEwooF

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 96bf50d7-7a64-4ca0-a5d4-3b4af80f5fb9

📥 Commits

Reviewing files that changed from the base of the PR and between b650b47 and 4dfb191.

📒 Files selected for processing (1)

• CLAUDE.md

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

• pydantic/logfire (manual)
• pydantic/pydantic-ai (manual)
• pydantic/pydantic (auto-detected)

✅ Files skipped from review due to trivial changes (1)

• CLAUDE.md

---

📝 Walkthrough

Walkthrough

This change adds a new "Writing standard" section to CLAUDE.md for public docs/ prose. It requires acronym expansion on first use, opening pages with their purpose, phrasing instructions in terms of user goals, stating where required values come from, and describing consequences plainly, especially when data leaves the machine or is dropped or redacted. It also limits the standard to docs prose and excludes normal API-reference docstrings.

Changes

Cohort / File	Change Summary
Documentation guidance / CLAUDE.md	Added documentation-writing standards for public docs prose

Sequence Diagram(s)

No sequence diagram generated; this is a documentation-only change.

Estimated code review effort: Low

Related issues: None provided

Related PRs: None provided

Suggested labels: documentation

Suggested reviewers: None provided

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly matches the main change: adding a docs writing standard to CLAUDE.md.
Description check	✅ Passed	The description is directly related to the change and summarizes the new writing standard accurately.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch dm/user-facing-copy-standard

---

_{Comment @coderabbitai help to get the list of available commands.}

[cubic-dev-ai]

No issues found across 1 file

Confidence score: 5/5

• Automated review surfaced no issues in the provided summaries.
• No files require special attention.

_{Re-trigger cubic}