Live data from Hacker News

Best Writing Advice for Engineers I've Ever Seen.

engineerwriting.jottit.com

31–40 of 75 posts

Re: Best Writing Advice for Engineers I've Ever Seen.

#31
post #5

http://www.amazon.com/Elements-Style-Fourth-William-Strunk/d...

Counterpoint: http://chronicle.com/article/50-Years-of-Stupid-Grammar/2549...

If it were less deliberately controversial it would be more digestible. As is, some of his points seems inconsistent, but that may be due to presentation.

Re: Best Writing Advice for Engineers I've Ever Seen.

#32
post #5

http://www.amazon.com/Elements-Style-Fourth-William-Strunk/d...

Counterpoint: http://chronicle.com/article/50-Years-of-Stupid-Grammar/2549...

Pullum on Language Log today: http://languagelog.ldc.upenn.edu/nll/?p=2235

Re: Best Writing Advice for Engineers I've Ever Seen.

#33
The other important thing needed is:

Make your message concrete and specific.

It is no use reading a first sentence that says something like: "We created a novel abstraction to improve software development.". Yes, it is concise, but it says nothing. "We used wavelet analysis to find and factor-out the most modified aspects of our code." -- that I can see I want to know more about.

Re: Best Writing Advice for Engineers I've Ever Seen.

#35
post #5

Earlier quoted context omitted.

Counterpoint: http://chronicle.com/article/50-Years-of-Stupid-Grammar/2549...

After reading that I am very glad that I never read that book. (Passive voice is a favorite of mine.)

The passive voice should be avoided.

Re: Best Writing Advice for Engineers I've Ever Seen.

#36
post #5

Earlier quoted context omitted.

Counterpoint: http://chronicle.com/article/50-Years-of-Stupid-Grammar/2549...

As on Fox News, for every opinion one can find a counterpoint. This particular counterpoint does more damage than good in the age of TL;DR. I'd rather read the writings of 'an educated person who knows they feel vaguely anxious and insecure whenever they write "however" or "than me" or "was" or "which,"' than the incoherence of someone who thinks grammar is pointless. I often see this counterpoint cited, but never it…

You've completely avoided reading Pullum's article, it seems. No one said grammar is pointless. No one said novices shouldn't learn grammar basics. Only that they shouldn't be taught falsehoods.

Re: Best Writing Advice for Engineers I've Ever Seen.

#37
post #18

Journalism class was the only worthwhile "language arts" class I took in high school. The "literature" ones were, IMO, mostly a bunch of horse shit and a waste of time, to put it very bluntly. There are classes and teachers that I looked back on more fondly when I was done with them because I realized they'd been good for me even if they were difficult, but none of the literature ones were in that category, only the…

Agreed. I've got a journalism background (though I'm now a web developer) and it has helped me tremendously.

The main thing is this: think and write carefully. I get emails from business people that are long, rambling, and at the end, I can't even tell what they mean or want. And the subject line isn't helpful if I need to find it later.

I write emails with the assumption that you've got 5 seconds to read it. Subjects like "Are we still meeting at 2PM today?" so you might not even need the body, which is short and to the point.

Also, if I have three unrelated questions for someone, I write three short emails. I want them to be able to answer two and flag one for later if necessary, without drudging up the other issues that were already solved.

The other great lesson from journalism is "people have short attention spans." The inverted pyramid is for hard news stories, but even fluff pieces try to start with really catchy first sentences and be clear throughout. If you lose people's attention too often, you lose your customers.

Many academics and businesspeople should learn from this - they often seem more concerned with sounding smart than really conveying information. Great ideas are no good if nobody hears about them. And in my experience, great minds are generally good at explaining their ideas clearly.

Re: Best Writing Advice for Engineers I've Ever Seen.

#38
post #18

Journalism class was the only worthwhile "language arts" class I took in high school. The "literature" ones were, IMO, mostly a bunch of horse shit and a waste of time, to put it very bluntly. There are classes and teachers that I looked back on more fondly when I was done with them because I realized they'd been good for me even if they were difficult, but none of the literature ones were in that category, only the…

Literature == art

Journalism == engineering

(both of the written word).

Complaining that literature is a waste of time is like saying I can't paint my house with oil paints and a tiny brush. Technically true, but you're really missing the point.

Re: Best Writing Advice for Engineers I've Ever Seen.

#39

Earlier quoted context omitted.

It's worth noting that the advice is just a comment left on an Edward Tufte thread (which, as a whole, is a lot more interesting): http://www.edwardtufte.com/bboard/q-and-a-fetch-msg?msg_id=0...

this wasn't clear to me from the link provided. edit: actually, this is an excellent demonstration of bad writing -- or rather 'blogging -- on behalf of whomever runs engineerwriting.jottit.com. The post is a straight copy out of another source, with a link to the source, with no explanation of what is going on, no discussion on the material, no value-add in general. This is something that I struggle with in my link-…

I pasted it to Jottit because a) I don't have a blog that's relevant to the topic, b) the original comment is hard to link to accurately due to sloppy coding on ET, and c) I wanted to try Jottit after learning about it. I considered adding an explanatory paragraph, but I felt it could be crude and self-promotional (if someone says something, they should have their name against it) as the quote stands alone pretty well.

The issues you raise regarding link sharing are valid, and exist, but in this case it's really just a cut and paste job (and if it were not interesting, I doubt it'd get 100 upvotes here). I could have put it on Gist, Pastie, or 101 other sites. The quote is the whole bit. No analysis necessary.

Nonetheless, this would have worked better as a brief personal blog post. If I get back into personal blogging, I'd certainly tackle it that way instead.

Re: Best Writing Advice for Engineers I've Ever Seen.

#40
post #18

Journalism class was the only worthwhile "language arts" class I took in high school. The "literature" ones were, IMO, mostly a bunch of horse shit and a waste of time, to put it very bluntly. There are classes and teachers that I looked back on more fondly when I was done with them because I realized they'd been good for me even if they were difficult, but none of the literature ones were in that category, only the…

Literature isn't about writing anymore than Computer Science is about programming. Part of your bad experience seems to stem from you not realizing this. The CS equivalent is assuming you're going to learn how to program in Theory of Computation.

The other part of your bad experience comes from the fact that your instructor was a poor educator. Grading solely based on the instructor's interpretation of the work is the canonical teaching mistake in English. Of course, having a bad instructor will make any course a bad experience, regardless of the discipline.

It's unfortunate your experience was so terrible because I find English to be very worthwhile. I've taken some of the most advanced undergraduate CS courses in the country and they were very worthwhile. Yet AP Engish senior year in high school and one English course in college match the CS courses in terms of being worthwhile.

I think it's best to clarify what I mean by worthwhile. One worthwhile moment in Computer Science was when I finally understood Lisp macros. Another one was when I understood Turing Machines. I'd say I've had about 5 or 6 of these moments over the past few years in CS. These are moments where you feel like you understand something in a fundamentally different and higher way. English produces similar moments, but they are about the world at large instead of just a technical field. Taking one English course per semester has netted me one or two worthwhile moments a month. It's really quite something.

If you're ever given the opportunity, I urge you to give literature another try. It's difficult to find a competent teacher, but it's worth the effort.

Post reply on HN