update

pages/Database Engineering.md

@@ -1,4 +1,5 @@
 - [[ACID]]
+- [[database innternals]]
 - [[database transaction]]
 - [[database partitioning]]
 - [[database sharding]]

pages/contents.md

@@ -81,4 +81,5 @@
 	- [[PHP]]
 	- [[Typescript]]
 - [[Database Engineering]]
+- [[technical writing]]
 -

pages/database innternals.md

@@ -0,0 +1,5 @@
+- how tables and indexes are stored on disk
+-
+- row-based vs column-based databases
+- primary key vs secondary key
+-

pages/database isolation levels.md

@@ -13,4 +13,5 @@
 - **serializable**: transactions are run as if they serialized one after the other
 	- no concurrency anymore.
 - ![](https://retool.com/blog/content/images/2020/03/Image-2020-01-21-at-5.48.02-PM.png)
+-
 -

pages/technical writing.md

@@ -0,0 +1,34 @@
+- internal knowledge
+	- the average employee spends close to 20% of every workweek looking for information or looking for help to complete their tasks.
+	- internal knowledge is the documentation of a company's processes, which employees can use as a reference to get their work done.
+	- 3 rules to have a successful internal knowledge
+		- it must be:
+			- centralized
+			- accessible
+			- up to date.
+	- the benefits of internal knowledge
+		- it saves time
+			- no more waiting time wasted in slack chat to get information that you need from your college or your co-worker or from another team
+		- it drives growth
+			- drive growth as one engineer would write instructions for example for deployment and other engineers now can replicate the steps written to do their own deployments. this would also save time for this engineer to explain to every other engineer
+	- the consequences of not documenting company knowledge
+		- priceless information lives inside the minds of a small number of employees
+- internal knowledge building steps
+	- define your audience
+	- do research
+	- create an outline
+	- write
+	- edit
+	- test
+- in technical writing instruction comes in 3 different forms
+	- FAQs
+		- a series of questions that customers commonly ask about a product or service. each question is accompanied by an answer that is short and to the point.
+		- it's an easy technical writing model so it's a great one to practice as a new technical writer.
+		- it has a simple two-part writing structure that you repeat as many times as needed, Question, Answer.
+		- different from step-by-step instruction FAQs are less goal-oriented they are not meant to focus the reader on completing a certain task and lead them to execute from start to finish, however, their purpose is to give readers quick answers to their most common questions
+		- skills for good FAQs
+			- research customer behavior, what they are asking about what are the biggest pain points.
+			- know your audience and write questions in their voice.
+			- write short and to-the-point answers.
+	- step-by-step instruction
+	- troubleshooting