4 ms·
I disagree with the premise that writing concisely is analogous to writing concise code. In fact, the opposite is more likely true. Why do we still have thousa
by open-source-ux 5y ago
I disagree with the premise that writing concisely is analogous to writing concise code. In fact, the opposite is more likely true.
Why do we still have thousands of poorly written program error messages of the meaningless 'invalid value' kind? Everyone immediately recognises this staccato style of writing common among developers.
Even modern programming languages have terrible compiler error messages. (Rust has made a commendable effort to display readable English compiler error messages.)
All this suggests to me that developers who write their English like their code are writing like a computer, not writing for other humans.
---
Here are two recommendations for writing clear English (excludes fiction) :
Plain English Campaign
This is a campaigning organisation from the UK which promotes clear, easy-to-understand written English suitable for any industry or profession.
Here is their clear, simple and short guide on How to write in plain English [PDF]:
http://www.plainenglish.co.uk/files/howto.pdf http://www.plainenglish.co.uk/files/howto.pdf
---
GOV.UK: 10 tips for clear writing
I find the tips at the following link very helpful:
https://gds.blog.gov.uk/2019/08/27/podcast-on-writing/ https://gds.blog.gov.uk/2019/08/27/podcast-on-writing/
You don't need to listen to the podcast at the top of the linked page (unless you want to). Scroll down the page and you'll find a short description of each of the following tips:
1. Establish ‘The Point’
2. Write it like you’d say it
3. Don’t try to sound clever
4. Show the thing
5. Know that you are not your writing
6. Share your work
7. Read (poetry in particular)
8. Never start with a blank page
9. Know when enough is enough
10. Stay human
- pkolaczk 5y ago“Programs are meant to be read by humans and only incidentally for computers to execute.” -- D. Knuth I believe that the ones who create error messages like "Invalid value" (without telling you the value nor why it was invalid) or "File not found" (without telling you the attempted file path) are not really good programmers. Concise != stripped from essential information. And I'm saying that as someone who always valued concise style of writing, and often got an equivalent of D (or sometimes F) in Polish writing assignments for my essays being too short. :D
- gnuvince 5y agoThat quote is not by Knuth, it's from Abelson and Sussman: https://mitpress.mit.edu/sites/default/files/sicp/full-text/book/book-Z-H-7.html https://mitpress.mit.edu/sites/default/files/sicp/full-text/... It's also a problematic quote, because it gives people the impression that they can just ignore that there's an actual computer running their code.
- pkolaczk 5y agoOh interesting, I stand corrected, thank you!