3 ms·
I would also say in the "what is it" part that projects intended for a broad audience should avoid jargon as much as possible. It's frustrating in my experience
by emilamlom 2y ago
I would also say in the "what is it" part that projects intended for a broad audience should avoid jargon as much as possible. It's frustrating in my experience to have to google several acronyms before I can even tell what the purpose is. (Security projects/programs are notorious for using way too many acronyms for example)
- j1elo 2y agoMy rule for writing documentation is as follows: first use of a commonly abbreviated term is written in its complete form, with the acronym or short form in parentheses. Then, the rest of the text in that same page can freely use the shorter form as needed. So "the File Transfer Protocol (FTP) is bla bla... When using FTP, remember to bla bla..." I think that's the most structured and correct way to introduce an acronym. Another style is to use "short form (long)" but "long form (short)" feels better to me (although I'm not a native speaker so maybe I got it the other way around!).
- kstrauser 2y agoYour method is the most common I’ve seen. I also come across this style often: > …using the File Transfer Protocol, or FTP.