Skip to content

Commit

Permalink
updated documentation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HariSekhon committed Sep 27, 2024
1 parent 5cecd4a commit 1df0442
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ If you've ever had this _"Why Bother?"_ approach to documentation, allow me to g
- you're not here to be a fancy author
- Explain Why
- give design reasonings and context behind decisions, trade-offs, chain of thought etc.
- Example: at a Hedge Fund I worked for [Confluent](confluent.md) platform would have cost them \$1M annually in
licensing so they chose to go with open source [Kafka](kafka.md) instead and just spent 3 months of engineer time...
on it, which unfortunately for us is not worth anywhere near \$1M!
- Example: at a Hedge Fund I worked for, they evaluated [Confluent](confluent.md) platform but found it would have
cost them \$1M annually in licensing so they chose to go with open source [Kafka](kafka.md) instead and just spent
3 months of engineer time on it, which unfortunately for us is not worth anywhere near \$1M!
- Show examples and practical code snippets
- Show use cases and real-world scenarios
- Add [Diagrams](diagrams.md) and screenshots where you can to aid visually
Expand Down

0 comments on commit 1df0442

Please sign in to comment.