documentation

Guidelines for creating technical documentation, READMEs, API specifications, technical books, and articles. [Most important] Handling of measured data and verification results ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Rules that must be followed: 1. Do not present data you did not actually measure or verify as "measured". 2. Do not record fictitious numbers as concrete values. 3. Do not use expressions that imply you validated something (e.g., "when we did ~", "as a result of verification"). 4. Do not include concrete numbers (memory usage, processing time, etc.) in Before/After comparisons. 5. Only cite official documentation, papers, or other reliable sources. Readers will assume the author actually verified the results. Expressions that make it seem like verification was performed when it was not betray readers' trust.