Rule Nr 1 in Science
Documentation is one of the main pillars of future advacement.
Yesterday I finished reading the "Project Hail Mary" book.
Leaving aside what I found a fascinating play, there was a phrase from the protagonist that caught my attention:
Rule Nr. 1 in Science
If something is changing unexpectedly, document it.
Write it down in a note,
take a photo,
record a video,
or even record a voice note.
The key is to share it,
Building in public.
This is exactly what
helped human progress
during history.
Even if it looks like
insignificant, it might
help someone else.
For that reason,
we should also make it
clear enough for everyone
by using systems like
the Feynman Technique.
"Documentation is the written and preserved history of a project, product, or process." Pragati Sinha
Importance of Robust Documentation
- Improve Collaboration: The docs help teams be on the same page, being aligned in a multi-crossed way.
- Scalability: A well documented project is able to scalate and grow properly.
- Trust: By adding sources to the documentation, information is much more reliable.
Key tenets of documentation
- Keep it Clear.
- Keep it Concise.
- Keep it Structured.
Sources
- Project Hail Mary book
- The Art of writing good documentation
- The key tenets of documentatio