Do you use "will", not "should" for processes?

Last updated by Tiago Araújo [SSW] 10 months ago.See history

When explaining steps in a process. For example, for printing a file, make sure to say something "will" happen or is happening. This is especially important when describing your own software, because saying something "should" happen implies that it may or may not happen (there could be bugs!).

::: greybox To print your document:

  1. Select File | Print. The Print dialog should now show
  2. Select the number of copies and click "Print". The file should now print ::: ::: bad Figure: Bad example - Using "should" implies uncertainty
    :::

::: greybox To print your document:

  1. Select File | Print. The Print dialog is shown
  2. Select the number of copies and click "Print". The file will now print ::: ::: good Good example - Using present or future tense implies confidence
    :::

This is not detected by SSW CodeAuditor because it picks up false positives.

Adam Cogan
We open source. Powered by GitHub