format

Any document that does not follow the rules below is subject to correction.

Write code comments or internal documentation in a certain tone.
Documents to be shown to the outside (general users) should be written more and more.
Always include definitions, meanings, or links to terms that appear for the first time in the document.
Use parentheses as a proviso only for sentences that are supplementary but necessary for understanding the main text, and use footnotes for sentences that are not essential for understanding the main text^{1</ sup>}.
If the content of the document is outdated, update it according to this method.

¹ See this for how to write footnotes. ↩