Skip to content

docs(dev-docs): Add async communication principles and decision documentation standard#16823

Merged
stephanie-anderson merged 4 commits intomasterfrom
dev-docs/async-communication-guidelines
Mar 9, 2026
Merged

docs(dev-docs): Add async communication principles and decision documentation standard#16823
stephanie-anderson merged 4 commits intomasterfrom
dev-docs/async-communication-guidelines

Conversation

@dingsdax
Copy link
Contributor

@dingsdax dingsdax commented Mar 6, 2026

Add async-first communication guidelines to the SDK developer docs, covering two areas that were absent from the existing principles and standards.

Principles (principles/index.mdx): two new entries inserted before the technical SDK principles:

  • Async-first — work must be understandable without attending a meeting; decisions belong in issues, docs, and PRs
  • Meetings are accelerators, not storage — meetings may clarify and unblock, but every decision-producing meeting must produce a written summary

Standards (coordination-maintenance.mdx): new decision-documentation SpecSection covering the full lifecycle of a decision — anchoring it in an issue before discussing, capturing notes/summaries if a meeting occurs, updating the issue immediately after, and moving Slack outcomes to the system of record (Linear, GitHub, Develop Docs). Includes a concrete good/bad example pair.

Existing principles already cover "decisions must be written down" and "discussion before implementation", so this PR adds only what was missing: the async-first mindset, meeting hygiene requirements, and the Slack → system-of-record rule.

…entation standard

Introduce two new working principles — async-first and meetings are
accelerators not storage — to make explicit that decisions must live in
written artifacts, not meetings or memory.

Add a decision-documentation SpecSection to coordination-maintenance
covering the full lifecycle: anchoring discussions in issues before a
decision, capturing notes/summaries during meetings, updating the issue
after, and moving Slack outcomes to the system of record.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Mar 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Mar 6, 2026 5:19pm
sentry-docs Ready Ready Preview, Comment Mar 6, 2026 5:19pm

Request Review

Co-Authored-By: Claude <noreply@anthropic.com>
Copy link
Contributor

@stephanie-anderson stephanie-anderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thank you!!

@stephanie-anderson stephanie-anderson merged commit 67aa219 into master Mar 9, 2026
17 checks passed
@stephanie-anderson stephanie-anderson deleted the dev-docs/async-communication-guidelines branch March 9, 2026 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants