3 ms·
Don't try to be funny in your docs. If you want to convey information, make it clean, precise, and to the point. Do not assume and do not distract. Please. P.
by gostsamo 5y ago
Don't try to be funny in your docs. If you want to convey information, make it clean, precise, and to the point. Do not assume and do not distract.
Please.
P.S. Jokes are not totally forbidden, but they should be more subtle and not so intrusive as "You are asking me a question, but here I'll give you a performance instead of an answer".
- hluska 5y agoYes, the word ‘oof’ denotes a performance. The etymology dates back to early vaudeville days when Barker Malarkey used it to start the Famous Malarkey Family’s drag show… Except that’s not true. That whole paragraph is a load of malarkey. It’s a word. You don’t know the person involved and you’re making more awful assumptions based upon three letters.
- gostsamo 5y agoNow, reverse it backward. Not only I don't know them, but neither they know me. Can you see the issue now? There is such a thing as technical writing style and it is about the relevance of information pieces and the relations between them.