Platform SDK: Debugging and Error Handling

Style Considerations

Users almost always prefer simple sentences that use simple present or past tense and active voice. The following table shows some examples.

Correct Incorrect
Registry Editor cannot create the subkey. Could not create the subkey.
Setup cannot start Program Manager. Setup was unable to activate Program Manager.
Floppy disk sector ID field does not match floppy disk controller track address. Mismatch between the floppy disk sector ID field and the floppy disk controller track address.
CHKDSK encountered an error during... An error was encountered during...
Cannot find %1. Could not find %1.
Modem does not respond. Modem not responding.

However, using active voice and simple constructions is less important than making your message searchable. Use passive voice and more complex constructions if necessary to place search-relevant words at the beginning of the message. The following table shows some examples.

Correct Incorrect
Log file size cannot be adjusted. Cannot adjust the size of the log file.

Or

Was unable to adjust the size of the log file.

Printing of %1 cannot resume. Cannot resume printing %1.

Or

Could not resume printing %1.