Documentation:ManualGuidelines

lastmod 2026-03-27created 2026-03-265 edits

General guidelines for writing manuals

Rules to apply

Do not use sentences that are ambiguous, open to interpretation, or cannot be quantified/formalized.
The requirements for a deliverable must be stated explicitly in a document and shared identically with everyone involved.
There must always be a completion date for the deliverable.
- Staff- and associate-level employees must show the direction and interim results before half of the schedule has passed.
  - Only when the schedule is 2 days or longer
The schedule must be met.
- "Met the schedule" does not mean shared the work done up to the deadline; it means "the agreed deliverable has been completed".
Send the result files by email before presenting the results.
- The deliverable sent by email must not be a LINK. It must be a file that can be viewed offline. (At least a PDF)
- If the recipient is external or at manager level or above, always attach "[Original document] + [PDF]".
After sending the results by email, "come in person to give a verbal report".
Use a template if one exists.
If no template exists, search for the most similar template and present it as a sample.
In the body content of a document, present enumerated values such as "present/absent" with emoji (✅,⚠️,❌) or the like so they can be judged at a glance.