diff --git a/docs/docs/handbook/product.md b/docs/docs/handbook/product.md index 3392b070c..08cfbf08c 100644 --- a/docs/docs/handbook/product.md +++ b/docs/docs/handbook/product.md @@ -2,7 +2,7 @@ title: Product --- -We use Github for 100% of our product / project management. +We use the [Jan Monorepo Project](https://github.com/orgs/janhq/projects/5) in Github for 100% of our product / project management. As much as possible, everyone owns their respective `epics` and `tasks`. @@ -10,21 +10,22 @@ As much as possible, everyone owns their respective `epics` and `tasks`. ## Organization -[`Projects`](https://github.com/janhq/jan/projects?query=is%3Aopen) +[`Project Labels`](https://github.com/janhq/jan/issues/labels) -- `Projects` track large, long-term, & strategic initiatives that can span multiple teams and multiple sprints +- `Project Labels` tag large, long-term, & strategic projects that can span multiple teams and multiple sprints +- Example label: `project: Jan has Mobile` - `Projects` contain `epics` [`Epics`](https://github.com/janhq/jan/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+epic%22) - `Epics` track large stories that span 1-2 weeks, and it outlines specs, architecture decisions, designs -- Each `epic` corresponds with a Github `milestone` +- Each `epic` corresponds with a `milestone` - `Epics` contain `tasks` -- `Epics` should only have 1 owner +- `Epics` should always have 1 owner [`Milestones`](https://github.com/janhq/jan/milestones) -- `Milestones` correspond 1:1 to `epics` and are used to filter [Project Views](https://github.com/orgs/janhq/projects/5/views/1) +- `Milestones` correspond 1:1 to `epics` and are used to filter [Roadmap Views](https://github.com/orgs/janhq/projects/5/views/12) - `Milestones` span 1-2 weeks and have deadlines [`Tasks`](https://github.com/janhq/jan/issues) @@ -32,7 +33,7 @@ As much as possible, everyone owns their respective `epics` and `tasks`. - Tasks are individual issues (feats, bugs, chores) that can be completed within a few days - Tasks under `In-progress` and `Todo` should always belong to a `milestone` - Tasks are usually named per [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) -- Tasks should only have 1 owner +- Tasks should always have 1 owner We aim to always work on `tasks` that belong to a `milestones`.