Skip to content

Commit 603222d

Browse files
committed
Revise principles section: consolidate and clarify audience perspectives and their specific needs
1 parent 478ca4d commit 603222d

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

introduction-to-codebase-interface/slides.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -162,19 +162,30 @@ graph TD
162162

163163
---
164164

165-
## Code Examples
165+
## Principles
166166

167-
```javascript
168-
function hello() {
169-
console.log("Hello, World!");
170-
}
171-
```
167+
1. Identify and empathise all audience perspectives on the codebase.
168+
2. Provide specific interfaces for each audience perspective.
169+
3. Keep interfaces clear, concise, and focused on audience needs.
170+
4. Regularly update interfaces as the codebase evolves.
171+
5. Set expectations and encourage feedback from all audiences to improve interfaces.
172+
173+
--
174+
175+
<!-- markdownlint-disable MD024 MD029 -->
176+
## Principles
177+
178+
6. Provide a replicable cross-platform codebase experience.
179+
7. Utilise cross-platform and cross-IDE tools and technologies.
180+
8. Provide a consistent abstraction over languages and frameworks.
181+
9. Do not be constrained by current technology and tools - provoke change.
182+
10. Empathise with your own future self who could become any of the audience perspectives at any time.
172183

173-
Code blocks are automatically syntax highlighted!
184+
<!-- markdownlint-enable MD024 MD029 -->
174185

175186
---
176187

177-
## Lists and Formatting
188+
## Benefits
178189

179190
- **Bold text** with `**text**`
180191
- *Italic text* with `*text*`
@@ -195,6 +206,14 @@ Press 'S' during the presentation to view them.
195206

196207
---
197208

209+
---
210+
198211
## Thank You!
199212

200213
Visit [codebaseinterface.org](https://codebaseinterface.org)
214+
215+
### Support
216+
217+
If you found this presentation helpful, consider supporting the project:
218+
219+
- ⭐ Star the [GitHub repository](https://github.com/codebase-interface/codebase-interface.github.io)

0 commit comments

Comments
 (0)