Skip to content

Commit 704e0d3

Browse files
committed
feat: expand documentation in index.md with principles and benefits for users and contributors
1 parent 30f17b6 commit 704e0d3

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

‎docs/index.md‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,36 @@
22

33
## Principles
44

5-
test test 1
5+
1. Identify and empathise with all audience perspectives on the codebase - contributors, users, operators, AI agents, Build agents.
6+
2. Provide specific interfaces for each audience perspective.
7+
3. Ensure each audience interface is clean and remains maintainable.
8+
4. Provide a consistent abstraction over languages and frameworks.
9+
5. Provide a codebase experience that can be replicated by any audience, anywhere and on any platform.
10+
6. Do not be constrainted by current technology and tools - provoke change to how we would like to interact with codebases over current constraints.
11+
7. Utilise cross platform and cross IDE tools and technologies to provide the interfaces.
12+
8. Empathise with your own future self who could become any of the audience perspectives at any time.
13+
14+
## Benefits
15+
16+
Benefits can be broken down per codebase audience type as they have been defined up-front. This is a benefit in itself as it allows to be considerate and then specific about the needs of each audience.
17+
18+
### Users
19+
20+
- Users expect to interact with the codebase via a specific entry point that is the README.
21+
- Users get a consistent experience across codebases and have expectations that can either be met or missed.
22+
- Users understanding when expectations are missed promotes feedback and improvement.
23+
- Users should be able to interact with the service based on the good user interface provided by the codebase.
24+
25+
### Contributors
26+
27+
- Contributors expect to interact with the codebase via a specific entry point that is the README.
28+
- Contributors get a consistent experience across codebases and have expectations that can either be met or missed.
29+
- Contributors understanding when expectations are missed promotes feedback and improvement.
30+
- Contributors should be able to make changes to the code base based on the good contributor interface provided by the codebase.
31+
32+
### Operators
33+
34+
### AI Agents
35+
36+
### Build Agents
37+

0 commit comments

Comments
 (0)