Per the JHA Style Guide for Technical Communication and Training, use the present tense rather than the future tense for documentation.
- Example
- Incorrect:
- This parameter will allow you to change an alternate rate for FDIC insurance on accounts with a balance in excess of the maximum.
- When you press Enter, a warning message will appear.
- This enhancement will add additional editing options to the PowerOn Deluxe Editor.
- Correct:
- This parameter allows you to charge an alternate rate for FDIC insurance on accounts with a balance in excess of the maximum.
- When you press Enter, a warning message appears.
- This enhancement adds additional editing options to the PowerOn Deluxe Editor.
Thank you,
Jackie Solano
Technical Writer, Episys Technical Publications
Symitar®
8985 Balboa Avenue
San Diego, California 92123
Direct Line: 619-542-6711
NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.
Leave a comment