Fix lint issues in `MANUAL.md`

This commit is contained in:
Pedro Pombeiro 2018-04-20 12:40:59 +02:00 committed by Pedro Pombeiro
parent 8d5673e214
commit c51946d067
1 changed files with 70 additions and 71 deletions

141
MANUAL.md
View File

@ -5,7 +5,7 @@ This document attempts to outline a broad set of guidelines so we can operate sw
What we are working towards is an entirely decentralized organization, where ideas and swarms are funded by any user, stakeholder, in the system. This is a non-trivial problem in terms of incentive design. To get there we are currently using a two-pronged approach. This document focuses purely on the first point:
1. Formalize swarm lead process and come to a shared agreement about role expectations
2. Run incentive/reputation design experiments through Open Bounty
Additionally, there will likely be some changes to ideas repository to
@ -15,84 +15,84 @@ facilitate the running of a swarm.
A swarm can be in the following states: draft, in progress, completed or aborted:
- A swarm starts off as an idea in draft mode
- Once an idea has been well-formulated and has enough interest, it is in progress
- By default, each swarm is removed from in progress at the end of each iteration period
- A swarm starts off as an idea in draft mode
- Once an idea has been well-formulated and has enough interest, it is in progress
- By default, each swarm is removed from in progress at the end of each iteration period
- If the swarm is still active, the swarm lead can mark it as in progress again
- If after the next period the swarm is still not in progress, it will be marked as aborted
- Once a swarm is determined to be done, it gets closed and marked as completed.
- If the swarm is still active, the swarm lead can mark it as in progress again
- If after the next period the swarm is still not in progress, it will be marked as aborted
- Once a swarm is determined to be done, it gets closed and marked as completed.
Additionally, a swarm that isnt in progress should not be actively worked on. This ensures we communicate things properly before doing them and we have a critical mass of development on the active swarms.
### Swarm status updates
A public status update that answers the following questions:
- What has been done since last time?
- Lessons learned
- What is the set of deliverables for the next period?
- What has been done since last time?
- Lessons learned
- What is the set of deliverables for the next period?
This is a way of ensuring accountability and providing a clear interface to the rest of the organization. It is also helpful for people who want to participate in a swarm and want an overview of what is going on.
## Swarm Lead
Thank you for being a swarm lead! This is a new type of role which we are still defining as we go and learn things, as well as refining the whole swarm concept. Being a swarm lead is different from being a traditional team lead in at least two ways:
- Swarm leads are self-nominated and based around a specific idea
- Swarms are ephemeral and have a specific lifecycle
- Swarm leads are self-nominated and based around a specific idea
- Swarms are ephemeral and have a specific lifecycle
### Swarm Lead Responsibilities
As a swarm lead, you are responsible for:
#### Being in an interface to the rest of the world.
- Reporting the status of the Swarm at the bi-weekly Town Hall using the report template
- Update Github Issue with this status (simple copy/paste)
- Interact with other swarm leads to ensure integration points are dealt with.
#### Being in an interface to the rest of the world.
#### Create a clear process and expectations for swarm members.
- Reporting the status of the Swarm at the bi-weekly Town Hall using the report template.
- Update Github Issue with this status (simple copy/paste).
- Interact with other swarm leads to ensure integration points are dealt with.
#### Create a clear process and expectations for swarm members.
- Overseeing prioritization of issues and work being done by swarm members.
- Creating a systemic cadence (e.g. weekly sync) for swarm members to sync.
- Have clear onboarding steps for new people who join the swarm.
- Overseeing prioritization of issues and work being done by swarm members.
- Creating a systemic cadence (e.g. weekly sync) for swarm members to sync.
- Have clear onboarding steps for new people who join the swarm.
#### Make sure there are clear goals for the swarm.
- Defining success metrics and exit criteria for the swarm.
- Set clear milestone for Swarm progress.
- Clarifying which OKR(s) the Swarm is tackling.
- Defining success metrics and exit criteria for the swarm.
- Set clear milestone for Swarm progress.
- Clarifying which OKR(s) the Swarm is tackling.
#### Engage people necessary to successfully complete the swarm.
- Engaging additional roles that are useful to the swarm, such as PM/UX/QA.
- Ensure theres an evaluator who is responsible for verifying exit criteria is met.
- Ensure people that join the swarm have the time available to dedicate.
#### Managing and communicating lifecycle of a swarm properly.
- Dont start swarm until it is out of draft mode.
- Make sure a swarm that is active is marked as in progress.
- Close swarm with a final written report, even if swarm is abandoned.
- Engaging additional roles that are useful to the swarm, such as PM/UX/QA.
- Ensure theres an evaluator who is responsible for verifying exit criteria is met.
- Ensure people that join the swarm have the time available to dedicate.
#### Managing and communicating lifecycle of a swarm properly.
- Dont start swarm until it is out of draft mode.
- Make sure a swarm that is active is marked as in progress.
- Close swarm with a final written report, even if swarm is abandoned.
## FAQ
### Should everyone be a swarm lead?
@ -116,15 +116,15 @@ Success Metric example: Onboarding conversion rate. Target >30% full funnel.
If in the above example, the new onboarding flow doesnt improve the conversion rate. The swarm should then disband, and create a new swarm to tackle the problem from a different angle.
One example of measuring success is to ensure there are Mixpanel events setup/created that will aid in measuring the impact of the swarm.
### What does it mean for a swarm to be well-defined?
- It contains clear success metrics and exit criteria
- Roles are clear and enough people are committed to it - a single swarm lead, a designated evaluator and a minimum of three contributors
- It has a clear description of future iteration (updated each Town Hall)
- It contains clear success metrics and exit criteria
- Roles are clear and enough people are committed to it - a single swarm lead, a designated evaluator and a minimum of three contributors
- It has a clear description of future iteration (updated each Town Hall)
### How can I make sure theres a regular cadence to my swarm?
Its up to you! It's often useful to keep a public Google Doc with meeting notes that can be referred to later. As a swarm leader, it can be helpful to get someone else to act as note taker while you drive the agenda. This note taker role can also rotate among participants in the swarm.
@ -162,18 +162,17 @@ General policy: 5-7 days means it is time to either merge or close a PR.
Lazy consensus mechanism: If reviewers come with feedback that isn't addressed
within a reasonable time frame, the PR can be closed. E.g.: feedback (48h) ping
(48h) => close PR.
### I have more questions / feedback
=> #swarms in Slack.
## Additional reading
- Organizational design: [https://wiki.status.im/Status\_Organisational\_Design](https://wiki.status.im/Status_Organisational_Design)
- Swarmwise book: [https://falkvinge.net/files/2013/04/Swarmwise-2013-by-Rick-Falkvinge-v1.1-2013Sep01.pdf](https://falkvinge.net/files/2013/04/Swarmwise-2013-by-Rick-Falkvinge-v1.1-2013Sep01.pdf)
- Swarmwise summary [https://docs.google.com/document/d/12Qema_8hPWuzDhqb8Tim66QZleVFcMXkVWICyH4nIT8/edit](https://docs.google.com/document/d/12Qema_8hPWuzDhqb8Tim66QZleVFcMXkVWICyH4nIT8/edit)
- EIP process: [https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md)
- Organizational design: [https://wiki.status.im/Status\_Organisational\_Design](https://wiki.status.im/Status_Organisational_Design)
- Swarmwise book: [https://falkvinge.net/files/2013/04/Swarmwise-2013-by-Rick-Falkvinge-v1.1-2013Sep01.pdf](https://falkvinge.net/files/2013/04/Swarmwise-2013-by-Rick-Falkvinge-v1.1-2013Sep01.pdf)
- Swarmwise summary [https://docs.google.com/document/d/12Qema_8hPWuzDhqb8Tim66QZleVFcMXkVWICyH4nIT8/edit](https://docs.google.com/document/d/12Qema_8hPWuzDhqb8Tim66QZleVFcMXkVWICyH4nIT8/edit)
- EIP process: [https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md)