docs(dev-docs): Add async communication principles and decision documentation standard#16823
Open
docs(dev-docs): Add async communication principles and decision documentation standard#16823
Conversation
…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 <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-Authored-By: Claude <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:Standards (
coordination-maintenance.mdx): newdecision-documentationSpecSection 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.