new meta til

Meta/checklist-documenting-medium-scale-system-architecture.md

@@ -0,0 +1,19 @@
+# Checklist for documenting a medium to large scale system architecture
+
+**_Posted on 03 Feb, 2024_**
+
+Some items that can help you document a undocumented legacy system.
+
+- [ ] Identify common points of failure in the architecture.
+- [ ] Identify uptime maintained in the last year (in 9s).
+- [ ] Identify maintainer/dev team size.
+- [ ] Identify specific version numbers of SDKs, APIs and packages used.
+  - [ ] Identify if updating SDKs can break the system.
+- [ ] Get entire server inventory list with os details.
+- [ ] Create documentation for the deployment strategies.
+- [ ] Create as many flowcharts/visual representations of the modules as possible. Way more than textual documents.
+- [ ] Make notes. Make lots of notes. Don't discard/delete anything. When you are actually documenting things, make sure all the notes you have made are checked for inclusion.
+
+## Acknowledgements
+
+- Big thanks to folks on `developersIndia` and `The Engineerin Org` discord for their inputs.

README.md

@@ -39,7 +39,7 @@
 * [Flutter](#flutter) [**`3`**]
 * [Git](#git) [**`10`**]
 * [Go](#go) [**`15`**]
-* [Meta](#meta) [**`1`**]
+* [Meta](#meta) [**`2`**]
 * [Miscellaneous](#miscellaneous) [**`13`**]
 * [Python](#python) [**`19`**]
 * [Shell](#shell) [**`29`**]
@@ -234,6 +234,7 @@
 ### Meta
 
 <ul>
+<li><a target="_blank" href="https://github.com/Bhupesh-V/til/blob/master/Meta/checklist-documenting-medium-scale-system-architecture.md">Checklist for documenting a medium to large scale system architecture</a>
 <li><a target="_blank" href="https://github.com/Bhupesh-V/til/blob/master/Meta/tech-writing-cookbook.md">Tech Writing Cookbook - Writing tips for you and my future self</a>
 </ul>
 

SUMMARY.md

@@ -143,6 +143,7 @@
 ## Meta
 
 <ul>
+<li><a href="Meta/checklist-documenting-medium-scale-system-architecture.md">Checklist for documenting a medium to large scale system architecture</a>
 <li><a href="Meta/tech-writing-cookbook.md">Tech Writing Cookbook - Writing tips for you and my future self</a>
 </ul>
 

count.json

@@ -1,3 +1,3 @@
 {
- "count": 145
+ "count": 146
 }

recent_tils.json

@@ -1,4 +1,12 @@
 [
+ {
+  "title": "Docker image load & save",
+  "url": "https://til.bhupesh.me/devops/docker-image-load-save"
+ },
+ {
+  "title": "Docker multi-platform build using buildx",
+  "url": "https://til.bhupesh.me/devops/docker-multiplatform-build"
+ },
  {
   "title": "Retrieval-Augmented Generation (RAG)",
   "url": "https://til.bhupesh.me/artificial intelligence/retrieval-augmented-generative-rag"
@@ -30,13 +38,5 @@
  {
   "title": "How to motivate and encourage volunteers",
   "url": "https://til.bhupesh.me/community building/how-to-motivate-and-encourage-volunteers"
- },
- {
-  "title": "Inserting NULL wherever possible on Postgres",
-  "url": "https://til.bhupesh.me/databases/inserting-null-everywhere"
- },
- {
-  "title": "Fundamentals of LLMs",
-  "url": "https://til.bhupesh.me/artificial intelligence/fundamentals-of-llms"
  }
 ]