On providing information without being an asshole.

What is wrong with the following quote found in the article How to set up the debugger for Chrome extension in Visual Studio Code?

Here’s a sample attach configuration.

Note: If you do not set the “url” option, a list will be prompted with your open tabs.

This extension have a lot of very useful options that you can use to adapt the configurations to your project. You can read the documentation of some of them here.

First, there is no link in the the first sentence. Second, that sentence is the only sentence in the entire paragraph. By the time the reader gets to the end of this paragraph without seeing the promised information they are pissed off and perhaps even screaming in rage.

Then the next paragraph is a seemingly unrelated note. When the reader sees this they are convinced that you are an asshole and a liar because you are never going to provide the information you promised.

Then in the following paragraph you seemingly change subjects and start talking about an extension. Yes, the very last word in this paragraph is a link that in fact leads to the information you promised in the first sentence but by the time the reader sees that link it is very likely too late. The best case scenario is a pissed off reader who is hoping to find the information you promised from another source. The worst case scenario is a pissed off reader plotting your untimely demise.

Do not do this. If you promise to provide a piece of information do it before the end of the paragraph, if not before the end of the sentence, in which you made the promise.