Skip to content

Commit

Permalink
chore(docs): add persona docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lino authored and Noki committed Apr 9, 2024
1 parent 10fb5d6 commit 3ecc1b6
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Contributing

It's great that you want to get involved. Here is some information to consider when working together and editing the content.

## Coordination

We coordinate the work in the [issues](https://github.com/freifunk-berlin/berlin.freifunk.net/issues) and in the [matrix channel](https://matrix.to/#/!GoqhUqFUgbZdMGZGvf:matrix.org).
New features should be created inside a feature-branch and introduced via a pull request. At least one approval is required. There is a test site for every branch at `https://dev.berlin.freifunk.net/<branch>/`.

## Personas

The design and content of the site should be adapted to the different people and their motivations. The following is a list of proto-personas that should be used as a guide.

### Average user

_... just wants access to the internet._

- wants to know where the closest access point is
- needs information about the security of the network
- is reporting problems

### Idealist

_... dreaming of a hierarchy-free future of the internet._

- wants to know about the structure of the mesh network and the key differences to the internet
- is willing to support in various ways
- sees the mesh network as the technical foundation for another future

### Hobbyist

_... motivated by technical interest and playfulness._

- is interested in technical details
- wants to play with the software and in the network
- could contribute in the development
- wants to talk/write with other geeks

### Other tech communities

_... searching for opportunities for cooperation._

- want to meet people to talk
- need to know what the options of cooperation are
- run their own software in the mesh network
- add sensors and other devices to existing locations

### Location owner

_... wants to provide free wifi in a secure way._

- wants to be in touch with other location owners
- needs information on legal stuff
- not that interested in the technical stuff
- needs to know what to do and where to ask for help if the location is down

## Structure of the website

When developing the structure of the website, it should also be taken into account that there are different roles of participation within the community. These exist independently of the personas, as the roles can be perceived through different motivations.

| Role | Description |
|--------------|-----------------------------------------------------------|
| πŸ§‘β€πŸ’» User | Using the network as a client. |
| πŸ§‘β€πŸ”§ Operator | Running and maintaining at least one node in the network. |
| πŸ§‘β€πŸ”¬ Developer | Working on the project in any way. |
| 🦸 Suporter: | Providing resources for the community. |

The layout should also take into account that there are [different types of documentation](https://www.writethedocs.org/videos/eu/2017/the-four-kinds-of-documentation-and-why-you-need-to-understand-what-they-are-daniele-procida/), each of which has its own purpose and target group.

- learning-oriented tutorials
- goal-oriented how-to guides
- understanding-oriented discussions
- information-oriented reference material

0 comments on commit 3ecc1b6

Please sign in to comment.