diff --git a/develop-docs/sdk/getting-started/playbooks/coordination/managing-linear-projects.mdx b/develop-docs/sdk/getting-started/playbooks/coordination/managing-linear-projects.mdx index 1a26c35988869..0236a46471ac6 100644 --- a/develop-docs/sdk/getting-started/playbooks/coordination/managing-linear-projects.mdx +++ b/develop-docs/sdk/getting-started/playbooks/coordination/managing-linear-projects.mdx @@ -104,10 +104,73 @@ You **MUST** set all of the following attributes before sharing the project with - **Status**: set to the appropriate state (`Planned`, `In Progress`, etc.) - **Target date**: realistic delivery date; **MUST** be set before the project moves to **In Progress** - **Team**: the owning SDK team -- **Description**: scope, goals, and non-goals; detailed enough that a new team member can orient themselves without asking +- **Description**: use the structured template below; detailed enough that a new team member can orient themselves without asking + +You should also set: + +- **Customers**: link relevant customer accounts or support tickets that motivated the work +- **Resources**: add relevant references — design documents (RFC, DACI, PRFAQ), Slack channels, related projects +- **Milestones**: define intermediate delivery milestones for longer projects to track progress incrementally A project without a lead, initiative, or target date **MUST NOT** be moved to **In Progress**. +##### Project Description Template + +The description **SHOULD** follow this structure (copy and fill in): + +```markdown +## Summary + + +## User-facing changes + + +## Why are we doing this? + + +## Expected outcomes + + +## In scope + +## Out of scope + + +## Dependencies + + +## Risks + + +## Definition of Done + +### Project-specific criteria + +- [ ] + +### Have we updated + +- [ ] [Public docs](https://docs.sentry.io/) +- [ ] [Develop Docs](https://develop.sentry.dev) +- [ ] [Sentry Conventions](https://getsentry.github.io/sentry-conventions/) +- [ ] [Sentry CLI](https://github.com/getsentry/cli) +- [ ] [sentry-wizard](https://github.com/getsentry/sentry-wizard) +- [ ] Public SDK example projects +- [ ] In-product prompts/onboarding +- [ ] Internal adoption/usage dashboards + +### Have you thought about doing a/an +- [ ] [Sentry Product Blog](https://blog.sentry.io/) post +- [ ] [Sentry Changelog](https://sentry.io/changelog/) entry +- [ ] [Sentry Engineering Blog](https://sentry.engineering/blog) post +- [ ] [internal blog post](https://vanguard.getsentry.net/) +- [ ] S&T video + +### Don't forget to create a follow-up issue to +- [ ] Check how the feature is performing after launch +- [ ] Promote the feature to GA +``` + #### 2. Add Pre-Implementation Documentation Before implementation begins, you **MUST** complete all pre-implementation documentation required by the [Design-First Gate](/sdk/getting-started/standards/planning-scoping#design-first-gate) and [Risk Identification](/sdk/getting-started/standards/planning-scoping#risk-identification) standards. @@ -178,6 +241,8 @@ Run these steps in order when all implementation and documentation is shipped. Verify closure against the [Definition of Done](/sdk/getting-started/standards/planning-scoping#definition-of-done) standard before setting the project to **Done**. +##### Close-Out Steps + 1. Verify all issues in the project are either **Done** or explicitly **Cancelled** with a note. 2. Post a final update summarizing: what shipped, any known follow-up work, and lessons learned. 3. Set the project status to **Done**. A project **MUST NOT** be set to **Done** if there are open issues that are not yet resolved or intentionally cancelled. diff --git a/develop-docs/sdk/getting-started/standards/planning-scoping.mdx b/develop-docs/sdk/getting-started/standards/planning-scoping.mdx index 4d6b633ea7238..b49a4448740ae 100644 --- a/develop-docs/sdk/getting-started/standards/planning-scoping.mdx +++ b/develop-docs/sdk/getting-started/standards/planning-scoping.mdx @@ -71,6 +71,8 @@ Issues estimated larger than **M** (or the team's medium equivalent) **MUST NOT* An issue or project **MUST NOT** be marked done if any of these conditions are unmet. "Mostly done" or "good enough" are not acceptable states — defer remaining work to a follow-up issue or project instead. +For a project description template including an artifact and communication checklist for the Definition of Done, see [Project Description Template](/sdk/getting-started/playbooks/coordination/managing-linear-projects#project-description-template). + #### Enforcement - Human review