Skip to content

Commit 0baf33a

Browse files
committed
docs: transacting a round of deep feedback
1 parent cc4619a commit 0baf33a

File tree

6 files changed

+199
-113
lines changed

6 files changed

+199
-113
lines changed

ARCHITECTURE.md

Lines changed: 117 additions & 95 deletions
Large diffs are not rendered by default.

PITCH.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Value Matrix
2+
3+
This section will explain how Standard intends to create value for different stakeholders.
4+
It is essential to have an idea of who they are, so let's introduce:
5+
6+
**_The Software Sponsor_**
7+
Makes resources available in return for the expectation of future benefits.
8+
9+
**_The Provider of Automation_**
10+
Sets up and maintains the automation alongside the SDLC.
11+
A helpful analogy would be the person who sets up and maintains the conveyor belt, which moves features to production.
12+
13+
**_The Consumer of Automation_**
14+
Consumes and co-maintaines the automation alongside the SDLC.
15+
A helpful analogy would be that this person not only uses and configures our conveyor belt, but is also capable of maintaining it.
16+
17+
It is equally essential to have an understanding what they value, so let's try to get an overview.
18+
We'll make use of a high level value matrix with simple sentiment scores:
19+
20+
- :heart_eyes: &rarr; <i>"absolutely love it!!!"</i>
21+
- :smile: &rarr; <i>"feels pretty good."</i>
22+
- :neutral_face: &rarr; <i>"whatever?!?"</i>
23+
24+
| | Software Sponsor [Principal] | Provider of SDLC Automation [Agent] | Consumer of SDLC Automation [Agent] |
25+
| ------------------------------------------------ | :--------------------------: | :---------------------------------: | :---------------------------------: |
26+
| Productivity | :heart_eyes: | :heart_eyes: | :smiley: |
27+
| Code Organization | :smiley: | :heart_eyes: | :smiley: |
28+
| Mental Model & Learning | :smiley: | :heart_eyes: | :smiley: |
29+
| Batteries Included | :neutral_face: | :heart_eyes: | :neutral_face: |
30+
| Community and Ecosystem | :neutral_face: | :heart_eyes: | :smiley: |
31+
| Reproducibility & Software Supply Chain Security | :heart_eyes: | :heart_eyes: | :neutral_face: |
32+
| Modularity & Incremental Adoption | :smiley: | :smiley: | :heart_eyes: |
33+
| Developer Experience & Onboarding Story | :smiley: | :smiley: | :heart_eyes: |
34+
35+
So, this is for you and your team, if you:
36+
37+
- Care about reproducibility
38+
- Value clean code
39+
- Have a deadline to meet
40+
- Want to serve an optimized UX
41+
42+
# Selling Points
43+
44+
The main selling points of Standard are:
45+
46+
- **Efficiency:** Standard automates the software delivery lifecycle, making the process more efficient and streamlined.
47+
48+
- **Reproducibility:** Standard's emphasis on reproducibility ensures that every stage of the SDLC can be easily replicated, leading to a more consistent and reliable software development process.
49+
50+
- **Speed:** Standard optimizes the critical path of the SDLC journey to achieve superior cycle times, which means that your software can be shipped to production faster.
51+
52+
- **Flexibility:** Standard is built to be flexible and adaptable, which allows it to be used in a variety of different contexts and industries.
53+
54+
- **Cost-effective:** Automating the software delivery lifecycle with Standard saves time and resources, making it more cost-effective.
55+
56+
- **Integration:** Standard is a horizontal integration framework that integrates vertical tooling, making it easier to stitch together different tools and processes to create a polished whole.
57+
58+
- **Community Outreach:** Standard is a part of the Nix ecosystem and is committed to community outreach to ensure that its optimization targets are met and that other perspectives are not dismissed.
59+
60+
These points show how Standard can help adopters to improve their software delivery process, and how it can save them time, money and improve the quality of their software.

ROADMAP.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,32 @@ This roadmap gives an overview of the short and mid term direction that the proj
77

88
## Deliverable Categories
99

10-
We've identified a couple of deliverable categories that should help us better understand the work spectrum associated with the project.
11-
Please also complement this with the high level overview in the [Architecture](./ARCHITECTURE.md).
10+
We've identified a couple of deliverable categories in line with the [architectural overview](./ARCHITECTURE.md).
1211

13-
##### Process Categories alongside the (automatable sections of the) SDLC
12+
These help us to better understand the work spectrum associated with the project.
1413

15-
- Setup Processes
16-
- The actual automatable parts of the SDLC Cycle
14+
##### Process Categories
1715

18-
While an instance of the actual SDLC process inside the boundaries of Standard's current scope is easy to break down into _eval_, _build_ and _effect/action_ and easy to measure with the _cycle time_ metric,
19-
the Setup Process is where adoption success or failure may be determined alongside:
16+
To run an _automation_ we have to _set it up_, first.
17+
We should keep that in mind when working on the backlog and therefore classify:
2018

21-
- Provided Documentation
22-
- Shared Mental Models
23-
- Curated Quick Start Template
24-
- Onboarding & Learning Context
25-
- Actual Installation and Setup
19+
- Setup
20+
- Automation
21+
22+
Work packages that supports setup typically involve:
23+
24+
- Documentation & Setup Instructions
25+
- Pattern & Shared Mental Models
26+
- Quick Start Template
27+
- Onboarding & Learning Content
2628

2729
##### Process Regions
2830

29-
As discussed in the [Architecture](./ARCHITECTURE.md) document, we roughly identify three regions with shifting characteristics alongside the SDLC:
31+
Per our [architectural overview](./ARCHITECTURE.md), we distinguishe these process regions:
3032

31-
- Development Environment Region
32-
- Build Pipeline Region (including CI control loops)
33-
- Continuous Delivery and Beyond (Application Lifecycle Management)
33+
- Development Environment
34+
- Build Pipeline
35+
- Deployment and Beyond (Application Lifecycle Management)
3436

3537
##### Deliverable Types
3638

@@ -45,6 +47,6 @@ As discussed in the [Architecture](./ARCHITECTURE.md) document, we roughly ident
4547
## Milestone v1
4648

4749
With the above in mind, the [issue backlog](https://github.com/divnix/std/issues) will be regularly groomed and prioritized.
48-
This is an aid for the core contributors, but it may also provide the necessary orientation and stability to convince interested new contributors.
50+
This is an aid for the core contributors, but it may also provide the necessary orientation to get new contributors set up.
4951

5052
Welcome!

artwork/components.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/PITCH.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../PITCH.md

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[Introduction](README.md)
44
[Design & Architecture](./ARCHITECTURE.md)
5+
[Sales Pitch](./PITCH.md)
56
[Roadmap](./ROADMAP.md)
67

78
# Tutorials

0 commit comments

Comments
 (0)