The primary goal of technical writing is to provide useful and necessary information.
Write Present
Write Present

Write Present

ORIGINAL:
ABC integrations are different from standalone apps. Say you were building a new email app. You would either use Gmail and Exchange’s APIs to connect to their services, or would build in support for IMAP, SMTP, and/or POP3 protocols. Your app would likely need a database to store every email message, a UI to manage folders, and an editor to write or view HTML email messages. It would need to support every core feature an email service like Gmail offers.

BETTER:
ABC integrations are different from standalone apps. Say you are building a new email app. You will either use Gmail and Exchange’s APIs to connect to their services, or will build in support for IMAP, SMTP, and/or POP3 protocols. Your app will likely need a database to store every email message, a UI to manage folders, and an editor to write or view HTML email messages. It will need to support every core feature an email service like Gmail offers.

EXPLANATION:
Writing in the pretense tense makes your documentation more active. It also gives it a less hypothetical feel. Here the passage is improved by replacing the word “were” with “will” and the were “would” with will.

Leave a Reply

Your email address will not be published. Required fields are marked *