Notes provide additional information that may not be essential for completing a task but is still valuable for the reader’s understanding. They help clarify details, explain exceptions, or provide context.
Purpose of Notes:
- Clarify complex concepts: Use notes to provide extra explanations or to clarify complex terms and concepts that might need further detail. Example: “Note: The term ‘latency’ refers to the delay before a transfer of data begins following an instruction.”
- Highlight exceptions or conditions: Use notes to highlight exceptions, conditions, or unusual scenarios that the reader should be aware of. Example: “Note: This feature is only available in version 2.0 and later.”
- Provide supplementary information: Include additional information that is useful but not critical to the primary task. Example: “Note: You can also access this function via the command line using the following command…”
Dos:
- Use notes to provide clarifications or exceptions: Example: “Note: The data will be saved automatically every five minutes.”
- Include notes for additional information: Example: “Note: For advanced configuration options, refer to the Settings section.”
Don’ts:
- Don’t use notes for critical or urgent information: Reserve these for tips or warnings.