Skip to content
This repository was archived by the owner on Nov 18, 2024. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 10 additions & 33 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,17 @@
# TBD Development Roadmap

Welcome to the TBD Development Roadmap. Here we describe the high-level focus of
our efforts, chunked into time-boxed deliverables as Milestones. This approach
lets teams operate with autonomy, while ensuring that everyone moves in the
same direction.
The roadmap is where we are and where we're going. It's a list of milestones:
waypoints that give teams enough direction to make decisions for their projects
while making for regular sync points. That way, code, programs, and people can
come together.

Milestones are encoded as a set of goals, defined by the
[SMART](https://en.wikipedia.org/wiki/SMART_criteria) model. Goals are:

* Specific
* Measurable
* Achievable
* Relevant
* Time-bound

Specificity is fluid. Because we are time-boxed, we make delivery estimates on
a best-case scenario and adapt as the milestone progresses. Work may have delays
due to any number of factors, and we employ a blameless culture when goals
must be rescoped. When we find our estimates are off, we simply communicate
our position to the team via Discussions where we can collectively assess impact
and adapt as necessary.

Relevance may also be fluid, leaving room to adapt our work to the changing
needs of the community. We reduce disruption here by releasing Milestones at
frequent, predicable intervals (typically 6-8 weeks).

Milestones will have minimum requirements, and in these cases we prioritize
work around themes. Missing a theme indicates a loss of focus and can hold up
others, so we take care to communicate our objectives here and stay true to them
during development.

Let's go.

## Milestones

| Milestone | Codename | Ends |
|-----------------------------------------|---------------------|---------------|
| [FUTURE](./milestones/MILESTONE_TBD.md) | Onwards | None |
| [001](./milestones/MILESTONE_001.md) | Bienvenidos a Miami | 05 April 2022 |
| Milestone | Codename | Ends | Status | Focus |
|------------------------------------------|-----------------------|---------------|---------|------------------------------------------|
| [FUTURE](./milestones/MILESTONE_TBD.md) | Onwards | None | 🟨 | |
| [003](./milestones/MILESTONE_003.md) | `TBD` | Q1 2023 | 🟨 | MVP of Web5, components feature-complete |
Comment on lines +14 to +15

@thehenrytsai thehenrytsai Jul 14, 2022

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Confusing naming: Milestone 3 is codenamed TBD, but we also have MILESTONE_TBD that is different. Consider either change codename TBD or rename to MILESTONE_TBD to MILESTONE_FUTURE.md

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yep anything without a number or a name yet I've slated as "TBD" - got a suggestion to make it more clear?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I thought milestone 3 codename is literally "TBD".
Consider either:

  1. Change codename Onwards to also TBD or
  2. Change codename TBD to something else or
  3. Rename MILESTONE_TBD to MILESTONE_FUTURE.md

| **[002](./milestones/MILESTONE_002.md)** | **`Call Me Maybe`** | **Q3 2022** | 🚧 ⬅ ️ | **MVP of HTTP APIs for components** |
| [001](./milestones/MILESTONE_001.md) | `Bienvenidos a Miami` | 05 April 2022 | ✅ | Working in public, code in repos |
36 changes: 36 additions & 0 deletions documentation/WORKING_MODEL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# TBD Community Working Model

## Roadmap

The [roadmap](../ROADMAP.md) is expressed as a list of milestones. It
provides teams with enough direction to make decisions for their projects,
while making for regular sync points so that code, programs, and people can
integrate at regular sync points. It's designed to give clarity to the community
about where we are and where we're going.

## Milestones

Milestones are encoded as a set of goals, defined by the
[SMART](https://en.wikipedia.org/wiki/SMART_criteria) model. Goals are:

* Specific
* Measurable
* Achievable
* Relevant
* Time-bound

Specificity is fluid. Because we are time-boxed, we make delivery estimates on
a best-case scenario and adapt as the milestone progresses. Work may have delays
due to any number of factors, and we employ a blameless culture when goals
must be rescoped. When we find our estimates are off, we simply communicate
our position to the team via Discussions where we can collectively assess impact
and adapt as necessary.

Relevance may also be fluid, leaving room to adapt our work to the changing
needs of the community. We reduce disruption here by releasing Milestones at
frequent, predicable intervals (typically 6-8 weeks).

Milestones will have minimum requirements, and in these cases we prioritize
work around themes. Missing a theme indicates a loss of focus and can hold up
others, so we take care to communicate our objectives here and stay true to them
during development.
2 changes: 1 addition & 1 deletion milestones/MILESTONE_001.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Every project will have:

The team will collectively have:

* #24 Welcome to new contributors in the `collaboration` repository `README`, introducing all the projects and how they come together to form a system
* Welcome to new contributors in the `collaboration` repository `README`, introducing all the projects and how they come together to form a system
* Contributed orientation development messaging to the temp TBD Site

## Project Goals
Expand Down
39 changes: 39 additions & 0 deletions milestones/MILESTONE_002.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Milestone 2

| Item | Value |
| ---------------- |-----------------|
| Codename | `Call Me Maybe` |
| Timebox delivery | Q3 2022 |

## Status

In-flight! ✈️

## Summary

Milestone 2 is about component-level minimum viability. It lets us
make demos and examples, and begins
integration. This sets up our next phase: bringing these
components together into a cohesive
[Web5](https://developer.tbd.website/projects/web5) Platform. That in turn
will form the basis for the
[tbDEX](https://developer.tbd.website/projects/tbdex) application.

## Goals

* Deliver MVP APIs for Components:
* [`dwn-sdk-js`](https://github.com/TBD54566975/dwn-sdk-js)
* [`ssi-service`](https://github.com/TBD54566975/ssi-service)
* [`ssi-sdk`](https://github.com/TBD54566975/ssi-sdk)
* DID (Decentralized IDs) SDKs

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

What exactly are these SDKs? Who should be working on these?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@csuwildcat knew where - some in SSI repos and some in DWN. Links to put here would be great.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

It's the ION packages (at least for now)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@csuwildcat Links I can put in there?

* Launch Public Programs:
* [Developer Web Site](https://developer.tbd.website/)
* [Tutorial and Example System](https://forums.tbd.website/t/tutorials-and-examples-system/89)

## Community Benefit

At the close of this Milestone, community members should be able to:
* Call upon the published APIs for the components
* Build examples and demos showcasing the SSI and DWN features
* Contribute those examples and demos to be published on the Developer Web Site
* Begin work with the core development team on integration of components into the Web5 Platform
39 changes: 39 additions & 0 deletions milestones/MILESTONE_003.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Milestone 3

| Item | Value |
| ---------------- |---------|
| Codename | `TBD` |
| Timebox delivery | Q1 2023 |

## Status

Scoping. 🔍

Goals and Community Benefit is incomplete,
and the summary is directionally-appropriate.

## Summary

Milestone 3 delivers feature-complete components, initially integrated
into a minimally-viable
[Web5](https://developer.tbd.website/projects/web5) Platform. This
sets up development of the
[tbDEX](https://developer.tbd.website/projects/tbdex) application and
is the prerequisite for client-side wallet development to begin.

## Goals

* Deliver feature-complete versions of Components:
* [`dwn-sdk-js`](https://github.com/TBD54566975/dwn-sdk-js)
* [`ssi-service`](https://github.com/TBD54566975/ssi-service)
* [`ssi-sdk`](https://github.com/TBD54566975/ssi-sdk)
* DID (Decentralized IDs) SDKs
* Deploy:
* DID Network running on TBD Infrastructure
* Launch Public Programs:
* TBD

## Community Benefit

At the close of this Milestone, community members should be able to:
* TBD
17 changes: 4 additions & 13 deletions milestones/MILESTONE_TBD.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,11 @@
# Future Milestone Ideas

### Technical Vision
Future milestone ideas reflect goals and community benefit
still to be slated in a Milestone.

`Bienvenidos a Miami` delivers a minimally-working `tbDEX` system. Its purpose
is three-fold:
## Goals

* Prove the architecture through running code
* Demonstrate the approaches taken
* Act as the first functional starting point for discussion and evolution

Integration takes precedence over feature depth. We'll be releasing the minimum
viable components which communicate together to solve the Team Goal.

## Team Goals

### Capabilities
## Use Cases for Examples

* User may create a DID
* User may apply for and receive a verifiable credential
Expand Down