Skip to content

Commit

Permalink
docs: update dev practices docs
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Jul 8, 2024
1 parent 0fe7bf7 commit 043a101
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 20 deletions.
28 changes: 8 additions & 20 deletions docs/dev-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ software development practices.
#### Issue Labels

- Label issues where appropriate, for example as backend or frontend.

- Priorities can be assigned:.

- `priority:critical`: blocking current tasks or user workflow.
Expand Down Expand Up @@ -116,7 +117,7 @@ software development practices.

Example (from FMTM):

![technical roadmap](./images/technical_roadmap.png)
![technical roadmap](./images/technical-roadmap-example.png)

#### User Roadmap

Expand All @@ -133,24 +134,7 @@ track my mapping progress more effectively`.

Example user roadmap (from FMTM):

<!-- markdownlint-disable -->

```md
| In Progress | Next | Future |
| ----------- | ---- | ------ |

|
| 🚀 As a mapper, I can have live mapping updates when online or can work entirely offline, for maximum flexibility. | 🗺️ As a mapper, I can easily download offline basemaps so I can navigate without connectivity. | 📻 As a project manager, I can deploy FMTM on a small field-based device in environments with connectivity restrictions. |
|
| 🎨 As a project manager, I have a standard/advanced project creation workflow, depending on my preferences and familiarity with the tools. | 🌍 As a project manager, I can export (+merge) the final data to OpenStreetMap to make it accessible. | 📱 As software developers, we will continue to collaborate with ODK to improve the experience in ODK Collect. |
|
| 🔗 As I mapper, I can open ODK Collect directly from FMTM, with a feature pre-selected, speeding up my workflow. | 🪓 As a project manager, I expect and reliable and configurable task splitting algorithm. | 📖 All users of FMTM have up to date documentation and tutortials for each step. |
|
| |🔒 As a project manager, I need to manage various additional user roles (validator, field admin) to ensure my project runs smoothly. | |
|
```

<!-- markdownlint-restore -->
![user roadmap](./images/user-roadmap-example.png.png)

### Task Board

Expand All @@ -166,7 +150,7 @@ Example user roadmap (from FMTM):

Example:

![dev task board](./images/dev_task_board.png)
![dev task board](./images/dev-task-board-example.png)

### Discussions

Expand All @@ -180,6 +164,8 @@ Example:

- No technical details, move those to a dropdown in markdown:

Example:

```md
<details>
<summary>Technical Summary</summary>
Expand All @@ -189,5 +175,7 @@ Example:
</details>
```

![release notes dropdown](./images/release-notes-technical-dropdown.png)

- Higher level info on bugs fixed, new features added, things improved.
- Add screenshots throughout.
File renamed without changes
Binary file added docs/images/release-notes-technical-dropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added docs/images/user-roadmap-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 043a101

Please sign in to comment.