Skip to content

Commit e2b6f1d

Browse files
committed
reviewed
1 parent fa72a50 commit e2b6f1d

File tree

2 files changed

+18
-17
lines changed

2 files changed

+18
-17
lines changed

docs/adrs/0019-feature-user-documentation-maturity.md

+18-17
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,35 @@ Proposed
88

99
## Context
1010

11-
In the context of a new product feature, we usually close (if not earlier) the delivery by adding its user documentation, that in the
12-
context of weave gitops is its documentation website https://docs.gitops.weave.works/docs/intro/.
11+
In the context of a new product feature, we usually close (if not earlier) its delivery by adding user documentation. In the
12+
context of Weave GitOps is its [documentation website](https://docs.gitops.weave.works/docs/intro/).
1313

14-
The user documentation helps any user onboarding to a new feature to
15-
- understand which problem address
16-
- how to get started with the feature or day 1 experience
17-
- how to do other advance scenario, operations or day 2 experience
18-
among other concerns.
14+
The user documentation helps a user onboarding to a new feature, among other concerns, to:
15+
- Understand the value the feature provides to the user.
16+
- How to get started or day 1 experience.
17+
- How to do other scenario like operations or day 2 experience.
1918

20-
However, in the context of adopting a new technology or solution, there is usually a process to build up confidence
21-
and uses cases to help managing the different risks associated. In the context of our documentation, we dont
22-
provide consistently information to user helping them to manage those risks and expectations so we leave
23-
to them to form an opinion and define how that adoption iterinerary looks like without guidance.
19+
However, in the context of adopting a new solution, there is usually a concern of building up confidence and managing risks.
20+
This concern, is not necessarily consistently addressed in our documentation, where sometimes we flag that info with documentation
21+
or a warning signaling it.
2422

25-
That opens two scenarios:
23+
![alpha-warning.png](images%2Falpha-warning.png)
2624

27-
1. if there is a match between what the user expectations is about maturity and the actual feature mature there wont be an missalingment.
28-
2. if not, that misalignment would show up in different ways: from "hey, this feature is not yet super mature" or "the app is crashing in production impacting XYZ revenue"
25+
Therefore, we leave the user to form an opinion and define how that adoption itinerary looks like without guidance. That opens
26+
(at least) two scenarios:
2927

30-
There are some potential actions to do here:
28+
1. If there is a match between user expectations about maturity is and the actual maturity, there wont be an misalignment.
29+
2. If not, that misalignment would show up in different ways: from "hey, this feature is not yet super mature" or "the app is crashing in production impacting XYZ revenue".
3130

32-
1. Do nothing, this is not an important decision to take or we dont want to take it because XYZ
31+
This ADR decides on the previous problem statement based on the following potential next steps:
32+
33+
1. Do nothing, this is not an important decision to take or we dont want to take it because XYZ.
3334
2. Do something acknowledging that we want to guide users in their adoption journey. In case we think we should do something:
3435
1. Follow a similar approach to [api version lifecycle](./0014-api-versioning-lifecycle.md)
3536
- maturity levels of Alpha, Beta, Stable with a baseline definition of these levels
3637
- guidelines on how to communicate the maturity without disincentive users to try out
3738
- other points
38-
2. Another approach
39+
2. Another approach TBD
3940

4041
## Decision
4142

docs/adrs/images/alpha-warning.png

27.2 KB
Loading

0 commit comments

Comments
 (0)