Skip to content

Commit e24298e

Browse files
committed
docs: weed out a round of typos and inconsitencies
1 parent 1bfcf26 commit e24298e

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

ARCHITECTURE.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ In particular, Standard is a _Horizontal Integration Framework_ which integrates
1515

1616
> Glossary:
1717
>
18-
> _Vertical Tooling_: does one thing and does it well in a narrow defined scope/vertical
18+
> _Vertical Tooling_ does one thing and does it well in a narrow scope (i.e "vertical").
1919
>
20-
> _Horizontal Tooling_: ovelay tooling that stiches vertical tooling together to a polished whole
20+
> _Horizontal Tooling_ stiches vertical tooling together to a polished whole.
2121
2222
In that context, the integration target are the end-to-end automatable sections of the SDLC process for which we offer well-integrated tools and best practices.
23-
_Efficient_ automatable sections of the SDLC are characterized by two things.
23+
_Efficient_ SDLCs are characterized by two things.
2424

25-
Firstly, an adequate _lead time_ which is the amount of time it takes to set up an initial version of the software delivery pipeline.
25+
Firstly, by adequate _lead time_ which is the amount of time it takes to set up an initial version of the software delivery pipeline.
2626
It needs to be _adequate_ rather than _just fast_, as it takes place in the context of a team and thus encompasses learning and onboarding activities.
27-
Rather than optimizing for speed, these need optimization for success.
27+
Rather than for speed, they need optimization for success.
2828

29-
Secondly, efficient automatable sections of the SDLC are characterized by short _cycle times_ which is the amount of time it takes for a commit to be shipped to a production environment.
29+
Secondly, by short _cycle times_ which is the amount of time it takes for a commit to be shipped to a production environment.
3030
Along this journey, we encounter our scope (more on it below):
3131

3232
- aspects of the _contribution_ environment;
33-
- the packaging pipeline that produces our distributable artifacts;
34-
- Continuous Building & Integration, Continuous Deployment as well as Continuous Observability and Discovery.
33+
- the packaging pipeline that produces artifacts;
34+
- and continous processes integrating the application lifecycle.
3535

36-
The goal of Standard is to optimize the critical path along this process to achieve superior _cycle times_ through the powers of Nix and Flakes when compared to any other similar framework that doesn't recognize the intrinsic value of _reproducability_.
36+
The goal of Standard is to optimize the critical path along this journey to achieve superior _cycle times_ through the powers of Nix and Flakes over frameworks in failure mode of disregard for the intrinsic value of _reproducability_.
3737

3838
## Scope
3939

@@ -45,38 +45,42 @@ The stipulated process regions are:
4545
- **Packaging Pipeline** which roughly covers _commit-to-distribution_. It is typically set up once and then orchestrated by a CI control loop.
4646
- **Continuous 'X' within the Application Lifecycle Management** which roughly covers _distribution-to-next-rollout_.
4747

48-
> Note:
48+
> Glossary:
4949
>
50-
> We use the term Contribution Environment to mean _Development Environment Plus_.
51-
> Compared to "development environment", it explicitely encapsulates aspects of contribution and integration in the broader process flow.
52-
> If you prefer, you can think "Development Environment" for practical purposes.
50+
> We use the term _Contribution Environment_ to mean _Development Environment Plus_.
51+
> Compared to _Development Environment_, it explicitly encapsulates aspects of contribution and integration of the broader process flow.
52+
> If you prefer, you can think _Development Environment_ for practical purposes.
53+
54+
While Standard is fundamentally concerned with optimizing across the end-to-end process, we also limit the scope inside this project repository for practical reasons:
5355

54-
While Standard is fundamentally concerned with optimizing across the end-to-end process, we also limit the scope inside this project repository for practical reasons.
55-
Therefor, we opt to delegate the **Contribution Environment** to a trusted project with an appropriate scope in the broader Nix Community, while employing community outreach to try to ensure our optimization targets are met or at least not accidentally sabotaged.
56-
On the other hand, we opt to delegate **Continuous 'X' within the Application Lifecycle Management** by dovetailing with more appropriate initiatives of adjacent ecosystems, such as for example [OAM](https://OAM.dev), which has developed an interesting model to reflect role boundaries naturally in their code interfaces.
56+
Therefore, we seek to delegate the **Contribution Environment** to a trusted project with an appropriate scope in the broader Nix Community, while employing community outreach to try to ensure our optimization targets are met or at least not accidentally sabotaged.
57+
58+
On the other hand, we seek to delegate **Continuous 'X'** by dovetailing and cultivating outreach with more appropriate initiatives of adjacent ecosystems.
5759

5860
## Ideals
5961

6062
The project is rooted deeply inside the Nix Ecosystem, but it strives to become a portal to make the powers of a store based reproducible packaging system readily available and palatable to colleagues and friends.
6163

6264
- _Use nix only where it is best suited_ — a Nix maximalist approach may be an innate condition to some of us, but trying to be a portal we deeply recognize and value other perspectives and don't dismiss them as ignorance.
63-
- _Disrupt where disruption is necessary_ — to our chagrin, the Nix ecosystem is quite a monotheistic silo. Therefore, we don't shy away from deviating from its widely accepted norms and standards when we feel that deviation has a greater chance at furthering the ideas of being a portal.
65+
- _Disrupt where disruption is necessary_ — to our chagrin, the Nix ecosystem is quite a monotheistic silo. Therefore, we don't shy away from deviating from its widely accepted norms and standards when we feel that it furthers our goals.
6466
- _Look left, right, above and beyond_ — our end-to-end perspective commands us to actively seek and reach out to other projects and ecosystems to compose the best possible value chain.
6567

6668
## Goals
6769

6870
- _Complete_: Standard should make a complete offer for setting up and running the automatbale sections of the SDLC.
69-
- _Optimized_: Standard should optimize for agent ("make your day-to-day life easier") and principle ("quick time to market"), alike.
71+
- _Optimized_: Standard should optimize for agent ("make your day-to-day life easier") and principle ("quick time-to-market"), alike.
7072
- _Integrated_: Standard should provide the best possible integration experience across a well-curated assortment of verticals.
7173

7274
## Value Matrix
7375

7476
In this section, we'll explain how Standard intents to create value.
7577
We'll make use of a simple value matrix with simple sentiment scores:
7678

77-
- :heart_eyes: → "absolutely love it!!!"
78-
- :smile: → "feels pretty good."
79-
- :neutral_face: → "whatever?!?"
79+
- :heart_eyes: &rarr; <i>"absolutely love it!!!"</i>
80+
- :smile: &rarr; <i>"feels pretty good."</i>
81+
- :neutral_face: &rarr; <i>"whatever?!?"</i>
82+
83+
The X-Axis represents the three prototypical stakeholder roles, while the Y-Axis represents the broad value creation categories that we have identified.
8084

8185
| | Software Sponsor [Principal] | Provider of SDLC Automation [Agent] | Consumer of SDLC Automation [Agent] |
8286
| ------------------------------------------------ | :--------------------------: | :---------------------------------: | :---------------------------------: |

0 commit comments

Comments
 (0)