Slashdot Mirror


Spring into Technical Writing

Simon P. Chappell writes "There is a school of thought that if you cannot explain what you've done, then what you did was worthless. Perhaps that attitude is a little extreme, but in this highly networked world of emails, instant messages, wikis, blogs and webpages, the art of explaining oneself well is important. While there are many books that teach written skills, there have been few ostensibly aimed at technical folks. Enter Spring into Technical Writing for Engineers and Scientists by Barry J. Rosenberg, a technical writer and the author of a number of technical articles and books including the KornShell Programming Tutorial." Read on for the rest of Chappell's review. Spring into Technical Writing for Engineers and Scientists author Barry J. Rosenberg pages 318 (with an 18 page index) publisher Addison Wesley rating 9 out of 10 reviewer Simon P. Chappell ISBN 0131498630 summary Solid writing advice for technical folks.

Who's it for?

The book's full title pretty much nails the intended audience; it is absolutely for engineers and scientists. Unlike most works on literary skills, this book treats you like a geek and realizes that you don't want to write prose, but you do want to communicate through a written medium. If you read Slashdot on a regular basis, know what Linux is or the majority of your books have diagrams, figures and tables instead of pictures, then you are a candidate for this book. If you can name more than one type of verb, then you may well be better sticking with your copy of The Elements of Style.

The "Spring into ..." series of books is based around the idea of transferring concepts quickly and efficiently. Barry, editor of the series as well as the author of this book, recounts his experience of a few years ago, when he had to learn a number of new skills quickly and could not find books that would meet that need. In his own words, "I didn't have time to become an instant expert, but I did have to become instantly competent."

The Structure

The book is split into four sections, each building upon the output generated in the previous section. The first section introduces the reader to the concept of technical writing, including how it varies from the other sorts, and then covers how to plan your documentation. Section two covers the actual writing. It starts with words, moves to sentences and progresses to paragraphs, before bringing in lists, tables and graphics. Section three looks at specific types of documents that are meaningful to engineers and scientists including manuals, web sites, proposals, lab reports, PowerPoint presentations and emails. The fourth section teaches basic editing skills, core concepts of typography and a discussion of practical punctuation.

Chunky, and I don't mean soup.

The series explains its topics in one or two page units that it calls chunks. The individual chunks in a chapter build on previous chunks. Delightfully, there are plenty of good examples throughout the book and each chunk has at least one example in it.

What's to like?

I found much to like about this book, and if any of these points ring true with you, then there's a good chance that you'll like it too. The first thing to note is hopefully obvious, and that is the quality of the writing. Or at least I'd hope that it would be obvious that the writing was excellent in a book about writing! There is an upbeat and cheerful tone that, even with a few corny jokes in the footnotes, doesn't cross the line into being either saccharine or condescending.

After the quality of the writing, the thoughtful division into chunks pretty much make the book for me. The information within the chunks is excellent, well indexed and easy to locate through the table of contents. The chunks cover task-sized activities; for example, you might wonder if a semicolon would work at a certain juncture. So you turn to chapter 20, the chapter on punctuation, and then to page 286, where a straightforward explanation of the correct usage of semicolons (with five good examples) awaits you.

While there are many depths to be explored in writing, this book stays close to the surface, giving enough help and guidance without turning the reader into an expert on composition. All advice is targeted for the concept, in the context of the likely circumstances that an engineer or scientist would need it.

The book stays on target all the way through. The stated audience of the book is engineers and scientists, and that remains the focus throughout. This makes a delightful change from books that claim to cover advanced topics, but start out trying to teach you the basics; Java books seem to be especially guilty of this.

The third section of the book covers many of the types of written material that a reader may be called upon to produce and not only gives examples, but it also shares tips and lessons learned from experience for each of the document types. Examples include pacing a PowerPoint presentation and writing a book proposal.

Oddly enough, for a book written about writing, for a technical audience, by a professional technical writer who also teaches occasionally at MIT, there is nothing to complain about in the writing department. So, switching to scraping the bottom of the barrel mode: I didn't like the ragged-right text justification and a few of the jokes were very corny. That's it.

Conclusion

This book does what it sets out to do, that is to equip engineers and scientists with the skills to communicate clearly and effectively through a written medium; whether that be a website, an email or a report. I recommend this book to everyone, from organizers to doers. Organizers like to write about what should be happening, and doers, while they may tend to shy away from writing, are often asked to write about what they've done for the organizers. This book covers that full circle.

You can purchase Spring into Technical Writing for Engineers and Scientists from bn.com. Slashdot welcomes readers' book reviews -- to see your own review here, read the book review guidelines, then visit the submission page.

173 comments

  1. Like a breath of fresh air by bigwavejas · · Score: 5, Insightful

    I think a book of this type is desperately needed, and I applaud the author. I for one am so tired of going to meetings where you get the "ass-kisser" type who can talk like a bigshot (yet does NONE of the work) taking all the credit. I work alongside some of the most brilliant engineers who are always overlooked for promotions or new opportunities simply because they aren't good at presenting or adding the burecratic fluff for managers who don't know a damn about what's involved behind the scenes.

    --
    "Simplify, simplify, simplify!" Thoreau
    1. Re:Like a breath of fresh air by `Sean · · Score: 4, Insightful

      A book on technical writing is all well and good, but quote a few geeks still need assistance grasping basic writing. I still say that Elements of Style should be in everyone's backpack or briefcase.

    2. Re:Like a breath of fresh air by `Sean · · Score: 1

      Wow. I suck. I figured I'd smack myself down for the typo before someone else does. :)

    3. Re:Like a breath of fresh air by ShaniaTwain · · Score: 1

      While I think what you say is very true, there is another element to it.

      Its not necessarily that technical people can't put things into a simple to understand format with pretty color graphs and all the right buzzwords - Its often that they just don't have the time. Thats not to say the proper documentation isn't vital or important, just that some people would rather spend their time actually making something work, and others are more interested in making something understood.

      That said, if you have the skills to do both you will suceed at pretty much whatever you try.

    4. Re:Like a breath of fresh air by Otter · · Score: 4, Interesting
      Its often that they just don't have the time...some people would rather spend their time actually making something work, and others are more interested in making something understood.

      I think the second half of that is more on target than the first. A lot of techies aren't willing to put in the time and effort to present their work well: because it's hard, because they lack confidence in their writing and speaking or just because it's not fun. And then they hide behind the excuse that speaking and writing poorly is a sign of 1337-ness.

      The problem is that for a lot of jobs, the maxim the reviewer brushed off is entirely true. If you can't explain what you did, you might as well not have done it.

    5. Re:Like a breath of fresh air by WindBourne · · Score: 1

      And yet, you did not point it out. Would like to quite it? :)

      --
      I prefer the "u" in honour as it seems to be missing these days.
    6. Re:Like a breath of fresh air by promantek · · Score: 2, Insightful

      I agree. Elements of Style is a great book.

      On Writing Well is another great book, though it's not exclusively about technical writing. It does, however, briefly cover it.

      It's definitely worth a read. Or three, in my case.

    7. Re:Like a breath of fresh air by Anonymous Coward · · Score: 0

      Good writing of any kind cannot contain "bureaucratic fluff" -- or fluff of any kind. Neither PHBs nor engineers need or want it, and any good book on writing will say this.

      In addition to the excellent Strunk & White, I recommend, "On Writing Well", by Zinser.

    8. Re:Like a breath of fresh air by Anonymous Coward · · Score: 1, Insightful

      the excuse that speaking and writing poorly is a sign of 1337-ness.

      I've found that it's just a sign of laziness or worse, stupidity. I chat on IRC everyday with people who speak English as a second or third language, and their English is impeccable. We consistently ridicule English speakers who just can't be bothered to spell properly. Those who don't speak English well enough to be understood, get "referred" to other channels where they can chat in their own native language.

    9. Re:Like a breath of fresh air by cratermoon · · Score: 2, Informative

      My recommendation: Style: Toward Clarity and Grace, by Joseph M. Williams. The main lesson of his book is how to drag your writing out of the context of expert knowledge and assumptions in your head and into a form that communicates what you really meant to people who can't get inside your head.

    10. Re:Like a breath of fresh air by Molochi · · Score: 1

      "Would like to quite it?" Beg your pardon?

      --
      "The Adobe Updater must update itself before it can check for updates. Would you like to update the Adobe Updater now?"
    11. Re:Like a breath of fresh air by Anonymous Coward · · Score: 0

      ./ers jump on your ass like a bloodhound on bacon for getting high-and-mighty on writing and therein misspelling a word, on the basis that (in my case) holding an English degree means you have 100% typing accuracy, have memorized a grammar book, and won the National Spelling B Championships when you were 12.

      Of course, the reason this is too much to expect is because English majors are inherently feeble and effeminate. I've never met a Bachelor of Computer Science who wrote buggy code on the first try.

    12. Re:Like a breath of fresh air by Saanvik · · Score: 1

      If your code is beautiful, but nobody can figure out how to use it (because you haven't documented it well), it's only going to be beautiful to you.

      In other words, spending time making something understood is part of making something work. It doesn't work unless people can use it.

    13. Re:Like a breath of fresh air by promantek · · Score: 1

      this looks like a really good book. i'm going to check it out.

      thanks for the recommendation!

    14. Re:Like a breath of fresh air by Fishead · · Score: 1

      "WOOOOOSSHHHH"

      That was quote close to hitting you as it flew over your head!

    15. Re:Like a breath of fresh air by Anonymous Coward · · Score: 0

      The ggp did a typo of but quote a few geeks, but meant to say but quite a few geeks

    16. Re:Like a breath of fresh air by WilliamTomBert · · Score: 1

      Yes - both the short and long version of the Williams book work wonders for all types of writing. "Clarity" in technical writing can be achieved with the lessons. Thanks for posting about it.

    17. Re:Like a breath of fresh air by `Sean · · Score: 1

      Touché. :)

    18. Re:Like a breath of fresh air by Anonymous Coward · · Score: 0



      Yes, it's needed, but the people who need it aren't going to be the ones who read it and take it to heart. Isn't always that way?


      p.s.

      It's cheaper here

    19. Re:Like a breath of fresh air by WindBourne · · Score: 1

      quite that out. now. No more of it.

      --
      I prefer the "u" in honour as it seems to be missing these days.
    20. Re:Like a breath of fresh air by Anonymous Coward · · Score: 0

      A book is all well and good, but, when I looked into technical writing as a possible career change, I got the impression that the field is very clique-oriented and the skills requirements are often inappropriate.

      For example, most positions advertised for writing _engineering_ documents wanted English majors. WTF?!? There also seemed to be arbitrary associations that writers aligned with for brownie points, I suppose, and the software required was often hard to have experience in (Framemaker).

      I just got an overall bad taste about the field of technical writing, like I would end up in a room with a bunch of arrogant pricks or something.

  2. Can someone please explain.... by Linuxthess · · Score: 2, Funny

    What the hell was he just talking about?

    --

    I sig, therefore I was.
    1. Re:Can someone please explain.... by 2nd+Post! · · Score: 0, Redundant

      Read the book, and you'll find out!

  3. Huh... by Tikicult · · Score: 4, Insightful

    This is why we are re-doing the software on all of our servers. We had 2 bozos building servers that were really bad at documentation. Policys scattered everywhere. We are also having to configure all of our switched from scratch, too.

    Write it down and when you are gone we will speak nicely of you.

    1. Re:Huh... by Anonymous Coward · · Score: 0

      Real programmers don't document. It was hard to write, it should be hard to read.

    2. Re:Huh... by Marxist+Hacker+42 · · Score: 5, Insightful

      Given today's problems with employer-employee loyalty- I'd rather you keep me around to begin with than to speak well of me when I'm gone.

      --
      SJW: a person who perceives an injustice, and while correcting it, commits a greater injustice.
    3. Re:Huh... by Anonymous Coward · · Score: 0
  4. Why isn't this book called ... by Anonymous Coward · · Score: 1, Funny

    ... Technical Writing Hacks for Engineers and Scientists?

    1. Re:Why isn't this book called ... by hobbesx · · Score: 1
      Speaking of which,
      did anyone else read the intro as:


      Read on for the rest of Chapell's review, Bitch.

      --
      This rating is Unfair ( ) ( ) Fair (*) Funny
      Sigh... If only. Modding would be so much more fun.
  5. Meh, easy by CypherXero · · Score: 1

    I took a Technical Writing course last semester in college. I didn't even buy the book, and I passed with an easy A.

    It's easier than English 101 or English 102.

    1. Re:Meh, easy by darklordyoda · · Score: 1

      You were just lucky.
      At Berkeley, with its oh so pleasant grade deflation, Technical Communication for Engineers is a long, involved class that very rarely gives out A's.

      Just as unpleasant, though, I'm sure.

    2. Re:Meh, easy by bhiestand · · Score: 1

      Maybe you couldn't get an 'A' because of your overuse of apostrophe's?

      --
      SWM seeks new sig for a brief fling
    3. Re:Meh, easy by Anonymous+Brave+Guy · · Score: 1

      Since you're being picky, you should know that the use of apostrophes to pluralize letters of the alphabet is widely regarded as good practice. Omitting them allows the inappropriate formation of words like "as" and "is".

      --
      If you disagree, post your argument. (-1, Overrated) isn't your personal censorship tool for views you don't like.
    4. Re:Meh, easy by bhiestand · · Score: 1

      To reply to "Since you're being picky", I apologize. It was a lot funnier with more alcohol in my system.

      Now to comment on the rest of what you said. "Widely regarded as good practice" is probably among the weakest excuse I've ever heard. I would've accepted "I prefer it that way". But come on. Its widely accepted too right like this, give it it's extra apostrophe, and basically just fsck things a few times. Most people won't notice, they'll even tell you you write "good".

      Of course it is widely accepted in the world of people who write good, and for very good reason.

      I was kinda hoping I'd get marked troll or funny and then have a +5 response to me reiterating all the rules for using apostrophes and explaining them. It works sometimes and would be rather appropriate for this topic. I'm feeling too lazy right now.

      --
      SWM seeks new sig for a brief fling
    5. Re:Meh, easy by Anonymous+Brave+Guy · · Score: 1
      Now to comment on the rest of what you said. "Widely regarded as good practice" is probably among the weakest excuse I've ever heard. I would've accepted "I prefer it that way".

      I'm not normally one to speak for others in on-line discussions; I automatically question any statement that begins with "Everybody knows that..." or something similar. However, in this case, I think the claim is justified: every book on good writing style I remember reading is consistent on this point.

      --
      If you disagree, post your argument. (-1, Overrated) isn't your personal censorship tool for views you don't like.
    6. Re:Meh, easy by Anonymous Coward · · Score: 0

      The rules of grammar and style are not set in stone, talk to a linguist and they will tell you that language is an evolving body of conventions. That is why there are different style guides (MLA, CMS, in house style guides) because the conventions of one group do not match the conventions of another. The style guides are an attempt to keep people consistent. If they were definitive they would have been called style rulebooks or something similar.

      Saying something is widely regarded as good practice is a perfectly acceptable reason to revise. Coincidentally if you check the style guides most will agree that the convention of using an apostrophe to pluralize a letter of the alphabet is the one to use.

  6. The Structure by intmainvoid · · Score: 3, Funny
    The book is split into four sections, each building upon the output generated in the previous section.

    You mean, like 99% of every other non-reference book out there?

  7. Techinical Writing in Progress by fwice · · Score: 4, Interesting

    There's a mandatory course at my university in regards to technical writing. All engineers have to take it. It's much better than the standard 'college writing' class (think boring lit times 10). in fact, students can only take this course in their third year or later (NU is a 5 year school).

    At that point, the student should have gone on a co-op, so the student should have some knowledge and insight into having something techinical to write about.

    The courses are taught by professors who have experience in the workplace environment (not professors who came straight from academia).

    all in all, the setup is wonderful for making a writing class useful and moderately enjoyable.

    --mike

    1. Re:Techinical Writing in Progress by dagny_dev_ · · Score: 1, Informative

      Most universities (of which I am aware) have 2 different mandatory 'English' classes - a technical writing class for engineers, math/physical sciences majors etc., and a general class for non-technical majors. However, from indications I've gotten from friends and colleagues (including an actual technical writer), these classes are woefully inadequate at preparing one for the workplace. This book looks good, and I enjoyed the review.

      --
      I have something to say. It's better to burn out than to FADE AWAY!
    2. Re:Techinical Writing in Progress by Chosen+Reject · · Score: 1
      not professors who came straight from academia

      Am I the only one who thinks professors in a technical field who came straight from academia deserve no respect? Where I am going to school there are several Profs who never worked in industry and they are the worst teachers.

      --
      Stop Global Warming!
      Just say no to irreversible processes!
    3. Re:Techinical Writing in Progress by GeneralHorel · · Score: 1

      Those who can make it in the Tech world do
      Those who can't, teach.

      --
      Slashdot sigs contain more useful information than the articals
    4. Re:Techinical Writing in Progress by Anonymous Coward · · Score: 0

      Shameless plug for my employer and website:

      http://www.uwtc.washington.edu/

      Certificate classes seem to be all the rage now. "A writing department in the College of Engineering? GASP! Are engineers... ALLOWED to write?"

    5. Re:Techinical Writing in Progress by Anonymous Coward · · Score: 0
      And the worst comp sci teacher I've ever had was a guy from Intel who was teaching a university course. What's your point?

      Teaching is a skill, and not necessarily one you become expert at in industry.

  8. Nice review by 14erCleaner · · Score: 3, Funny
    That was a surprisingly well-written, easy-to-read review.

    Of course, maybe that shouldn't be surprising, given the book you just read. Sounds good.

    --
    Have you read my blog lately?
  9. One problem by Anonymous+Crowhead · · Score: 3, Insightful

    In my experience, everyone who can't write worth a damn thinks they can.

    1. Re:One problem by FrankDrebin · · Score: 1

      In my experience, everyone who can't write worth a damn thinks they can.

      ...and are uniquely qualified to submit stories to, or even become an editor on, Slashdot.

      ;-)

      --
      Anybody want a peanut?
    2. Re:One problem by AnonymousKev · · Score: 2, Funny

      Funny. I've noticed that problem also exists in the area of software design.

      --
      Anonymous Kev
      Proudly posting as AC since 1997
      (Finally got a dang account in 2004)
  10. Read the Elements of style by wsxian · · Score: 4, Informative

    When I went to Law School and Business School this book was praised: The Elements of Style by Strunk available here: http://www.bartleby.com/141/

    1. Re:Read the Elements of style by Anonymous Coward · · Score: 0

      nice link... i would just like to chime in that i also have heard nothing but good things for the book.. but as you can tell by my ending sentences in ... that i have a ways to go....

    2. Re:Read the Elements of style by Anonymous Coward · · Score: 0
      The Elements of Style is a good beginner's reference.

      "Rules are for the obedience of fools and the guidance of wise men."

  11. Communication is not bureaucratic fluff by Anonymous Coward · · Score: 3, Insightful

    Communication in language is as technical an achievement as communication in code. It takes a little learning and a lot of practice. It is far from "ass-kissing" or bureaucratic fluff. Almost EVERYONE has problems with the written and spoken word. This is not some downfall of geeks only. And your code is only as good as your communication skills if you are working on a team or anyone other than you will need to read the code. Geeks need to see good communication as a technical challenge, which it is.

    1. Re:Communication is not bureaucratic fluff by Anonymous Coward · · Score: 0

      So does this means you learn a new language by reading the code of the compiler ?

    2. Re:Communication is not bureaucratic fluff by chris_mahan · · Score: 3, Insightful

      if you program in python, say, and you understand the python interpreter, but can't speak in a meeting about what value added your program provides, you're still in the wrong industry.

      --

      "Piter, too, is dead."

    3. Re:Communication is not bureaucratic fluff by Marxist+Hacker+42 · · Score: 1

      Value added is for project managers, not coders. If you aspire to be a project manager fine- but don't make me read through 200 lines of comments for every 150 lines of code. Only the code matters- the rest is just meatspace.

      --
      SJW: a person who perceives an injustice, and while correcting it, commits a greater injustice.
    4. Re:Communication is not bureaucratic fluff by jscotta44 · · Score: 1

      Let us see how reverse arrogance works. Hmmmmm...

      Anybody working an a team of humans ought to be able to explain what they are doing. If they can't, they are working with the wrong species.

      Yep. That sounds just as stupid as what you wrote. Everyone has skills. Some people have stronger skill than other people. Do you have any idea how many good ideas have died because the "engineer" (term used loosely to cover a wide variety of people who create great stuff) was not able to persuade other people of the worth of the idea/product/service/etc.? Much. Do you know how much mediocre stuff gets into the world because the people in charge of it know how to persuade others to use/buy it? How about I just put Microsoft on the table as Exhibit 1.

    5. Re:Communication is not bureaucratic fluff by chris_mahan · · Score: 2, Insightful

      I'm a programmer for a fortune 500. You have to explain the code to the project managers.

      Code in comment rule of mine: 1 line of comment per line of code, max.

      Other rule of mine: If you can't explain your program to a project manager, he's not going to be able to explain it to other people.

      Value added: Ah, if you the coder don't know why you're writing the code, how do you know you're doing it right? The recs? I'm lucky if I have a screenshot with hand-drawn lines.

      --

      "Piter, too, is dead."

    6. Re:Communication is not bureaucratic fluff by Marxist+Hacker+42 · · Score: 1

      And as long as we continue to coddle such people, they will continue to outbreed us. If intelligence is going to count for anything at all in the war that is survival of the fittest, then the stupid need to not be allowed to survive.

      --
      SJW: a person who perceives an injustice, and while correcting it, commits a greater injustice.
    7. Re:Communication is not bureaucratic fluff by RevMike · · Score: 1
      Value added is for project managers, not coders. If you aspire to be a project manager fine- but don't make me read through 200 lines of comments for every 150 lines of code. Only the code matters- the rest is just meatspace.

      Even if I can understand the code, why should I wade through it when I don't have to? I want to understand the broad architecture quickly, then deep dive at a particular area of interest. In this kind of environment, too many comments is just as bad as too few.

      The "correct" amount of commenting is a brief description at each major block of code, plus a detailed description at any "dangerous curves". For instance:

      A brief description for a block of code might look like this... "Here we iterate through the set, discarding any elements that don't fit the criteria defined above."

      A dangerous curve comment might look like this... "When the criteria is met, this evaluation caused an overflow condition, which automatically terminates the loop and transfer control back to the calling method."

    8. Re:Communication is not bureaucratic fluff by Marxist+Hacker+42 · · Score: 1

      It's a good way to do it. But far better is already KNOWING several different programming languages + assembly, machine code if you can get the basic processor manual. Only then will you truly understand what programming is.

      --
      SJW: a person who perceives an injustice, and while correcting it, commits a greater injustice.
  12. worthless... by odyrithm · · Score: 1

    "if you cannot explain what you've done, then what you did was worthless"

    I get that feeling everytime I have a meeting with the big cheeses.

    --
    moo
  13. Why shooud I take tecnical riting? by pg110404 · · Score: 4, Funny

    My riting is just grate. I don't need there book to tell me how to rite better.

    Now I goota get back to my tecnical documenteation for this project I'm dooing over hear.

    BTW, wat excactly does a java inturfaice do again?

    1. Re:Why shooud I take tecnical riting? by Anonymous Coward · · Score: 0

      You forgot the infamous misuse of the homonyms "to", "too" and "two".

      e.g. Some guy took to exams two early in the morning, but forgot too write his name on them.

      When I see the word "too" used where "to" should have been, my internal-rage-o-meter spikes madly.

  14. Just b/c you get an "A" ... by ionrock · · Score: 2, Insightful

    doesn't mean you deserved it. With colleges forcing grad students and junior faculty to meet quotas regarding grades, an "A" is very rarely the result of your hard work in a course like technical writing. In addition, technical writing courses rarely deal with things like specs and design documents in a realistic fashion. The teachers in these kind of courses are meant to analyze very basic elements that revolve around following instructions more than writing a spec that is easy to understand and use.

    I am not saying you did not deserve your grade, but I am saying that good technical writing in context is not easy.

  15. Boing!!! by Timesprout · · Score: 0

    boing boing, boing boing boing boing-boing, boing boing-boing boing. Boing-boing boing boing boing boing boing.

    A spring vividly and concisely summarizing a technical spec.

    --
    Do not try to read the dupe, thats impossible. Instead, only try to realize the truth
    What truth?
    There is no dupe
  16. The art of technical report writing... by VectorSC · · Score: 2, Funny

    I was going to say something mean about technical report writing, but I can't really describe correctly exactly how I feel about this subject.

    1. Re:The art of technical report writing... by VectorSC · · Score: 1

      Thanks. Don't forget to tip your waitress.

  17. Ragged-right by tsanth · · Score: 2, Informative
    I didn't like the ragged-right text justification
    Actually, ragged-right text justification is often used to allow the eye to follow the text more easily.
    1. Re:Ragged-right by Anonymous Coward · · Score: 0

      > I didn't like the ragged-right text justification
      > > Actually, ragged-right text justification is often used to allow the eye to follow the text more easily.


      The ragged-right justification made it easy to follow the review. Especially the bit about not liking the ragged-right justification.

  18. Writing Sklls by Anonymous Coward · · Score: 0

    Never buy a book from an author teaching written skills. The author clearly needs to work on his writing skills.

    -A12

  19. Rule#1: Respect your audience by TimTheFoolMan · · Score: 4, Insightful

    While I applaud the author too, everyone needs to recognize that there is no substitute for "caring about the reader," and quite frankly, most technical people don't have the time (or want to expend the time) to learn how to explain themselves to a non-technical audience. More specifically, we don't feel that the audience is worth this expenditure of time.

    As a project manager, one of the greatest skills I can bring to the table is being able to communicate effectively with the technical people (TP) on my team, and then turn around and explain to the non-technical people (NTP) in our organization what the heck they were talking about, and why it's important. I'm able to do this, in large part, because I have respect for people on both sides of the equation, and take the time to understand what they're saying, and communicate in their terms.

    Unfortunately, there is traditionally very little respect from either of these camps, going either way. As long as we TP assume that we're talking to PHB's, Boneheads, and Golden Parachute Weenies(tm), it's going to show in the way we write.

    If instead, we presume NTP to be intelligent, with a different (but still valuable) skillset, and keep that mindset at the forefront, our consideration for their intelligence will come through and so will our message.

    Here's a test. Take your last technical proposal, and consider how you would structure and word it for (insert name of close, non-technical relative such as Mom, Dad, etc.). Then, write it that way, but without the analogies to Mom's wonderful cooking, or Dad's "Viagra incident." I guarantee that if you respect the audience, and don't talk down to them, you will improve your writing and communication.

    Add in the practical suggestions from a book like this, and you should be in good shape. However, neither one of these components is a substitute for the other.

    Tim

    1. Re:Rule#1: Respect your audience by James_Aguilar · · Score: 1

      In my book, the real problem is that most technical people are incapable even of writing to a technical audience. That, my friends, is what is embarrassing about the current state of affairs.

    2. Re:Rule#1: Respect your audience by Dystopian+Rebel · · Score: 1

      I don't know about other engineers, but I have the utmost respect for the Typing Pool.

      --
      Rich And Stupid is not so bad as Working For Rich And Stupid.
    3. Re:Rule#1: Respect your audience by plsander · · Score: 1

      Readability helps too.

      The best technical manual I have ever come across is "How to keep your volkswagen alive" by John Muir. It is the only car repair manual that I have ever read cover to cover for the pleasure of it. (Come to think of it, being stuck on summer camp staff might have had something to do with that too.)

      Muir's writing style managed to explain both the steps to changing the timing of your Beetle's distributor cap, but also the why you would have a vacume vs mechanical advance distributor.

    4. Re:Rule#1: Respect your audience by Geeky · · Score: 1

      Yes! I love that book.

      My favourite bit was his advice on buying a Beetle - if I recall correctly, some very hippy crap about sitting crosslegged on the ground, contemplating it to see if the vibes felt right. He then said that at the very least, it might freak the seller out and get them to lower their price a bit just to get rid of the weirdo...

      Brilliant mix of hardcore technical advice and offbeat oddness that should be understood by any Beetle owner (sadly my 1971 1300 is off the road pending some serious welding work)

      --
      Sigs are so 1990s. No way would I be seen dead with one.
    5. Re:Rule#1: Respect your audience by mikefe · · Score: 1

      That may not be a good analogy.

      Some consider their parents to be PHBs.

      --
      There: Something at a specific location.
      Their: Owned by someone.
      Please make sure your english compiles.
  20. How does this compare to... by dutchd00d · · Score: 1
    1. Re:How does this compare to... by wuie · · Score: 3, Informative

      A Guide to Writing as an Engineer?

      I used this book when I went to college, and found it very useful when writing a variety of papers, from cover letters to resumes to technical reports. It quickly became one of the first books I reached for when writing any technical documents, such as a final report describing an AI program that I wrote in my senior year. I highly recommend it.

      I was exposed to this book primarily because I was a CS student at an engineering college, and it often makes me wonder what my CS studies/reports would have turned out without this resource book by my side.

    2. Re:How does this compare to... by El+Pollo+Loco · · Score: 1

      Holy Shit, other people from Colorado School of Mines!

    3. Re:How does this compare to... by wuie · · Score: 1

      Holy Shit, other people from Colorado School of Mines! Wow, and I think I know who you are! ;)

  21. There's another school of thought by I8TheWorm · · Score: 1
    There is a school of thought that if you cannot explain what you've done, then what you did was worthless.
    If it was hard to write, it should be hard to read.
    If I have to support one more system written by folks like my father, who lived by that creed, the next time you'll see me will be in the evening news.
    --
    Saying Android is a family of phones is akin to saying Linux is a family of PCs.
    1. Re:There's another school of thought by guitaristx · · Score: 2, Insightful
      There is a school of thought that if you cannot explain what you've done, then what you did was worthless.
      If it was hard to write, it should be hard to read.

      I've found, as a programmer, and as a general "techie", my years of experience doing Quality Assurance (QA) has been rather valuable. I've learned from multiple former employers that they'd have increased my salary to match or beat the job I was leaving for if they knew how few programmers with good writing skills existed. I was forced to leave one company because they offered me $48k with sparse benefits to relocate to a place with 2x the living expenses (I was making $30k at the time). I now live in the same place, earn (take-home pay) about the same, and my former manager is kicking herself for letting me go so easily.

      Anyone who's in a technical field should seek more opportunities to write. Get involved in open-source; OSS is always in need of people willing to write docs. Get on an IRC channel or mailing list where OSS devs frequent, and you'll have them banging on your e-door if you say you'd like to help write documentation. It's great experience, it's a wonderful thing to put on your résumé, and it helps give the OSS community a better public image.

      In any case, there is no reason to perpetuate the stereotypical role of engineers and technical people by ignoring such a crucial area as technical writing.
      <dune>Long live the writers!</dune>
      --
      I pity the foo that isn't metasyntactic
  22. The Tipping Point by Anonymous Coward · · Score: 0

    "There is a school of thought that if you cannot explain what you've done, then what you did was worthless. "

    Blink: The power of thinking without thinking by Malcolm Gladwell would disagree with you.

  23. My thoughts... by Anonymous Coward · · Score: 0

    There's a mandatory course at my high school [stlawrence.edu] in regards to technical writing. We all have to take it.It's much easier than the standard 'high school writing' class (think about literature, with the stupid old teacher, times 10). in fact, students can only take this course in their junior year or later, even through it so damn easy.

    By this point, we've learned how to do stuff, and should have knowledge of writing.

    The courses are taught by profs who have little experience in the workplace, after all they've been teaching forever. They come straight from college or something.

    All in all, the courses are better than taking the standard literature (much easier!) but I'd rather stay home sick any day.

    --tom

    1. Re:My thoughts... by Clover_Kicker · · Score: 1

      I see 3 spelling/grammar mistakes in your first paragraph, maybe you should be paying more attention.

  24. Disagree by coflow · · Score: 0, Troll

    if you cannot explain what you've done, then what you did was worthless

    If you can't understand what I've done by my source code, then you're worthless.

    1. Re:Disagree by jimicus · · Score: 1

      That's very nice for you. And when your source code is just part of a multi-million line project, and I want to use your software rather than develop it further, what then?

    2. Re:Disagree by coflow · · Score: 1

      I'm sorry, I forgot to include the marks for those of you in the UK. ;-)

    3. Re:Disagree by coflow · · Score: 0, Redundant

      Crap, that's what preview is for...... I meant:

      I'm sorry, I forgot to include the <sarcasm> tags for those of you in the UK. ;-)

    4. Re:Disagree by JerryBruckheimer · · Score: 1

      Though you admit to being sarcastic in follow-up posts, there is a grain of truth to this when it comes to programmers (not for end users, as you note). Some programmers only use code comments when they're doing something unusual, which is not necessarily a bad practice. If your objects and methods are named well, the reader should be able to figure out the code without comments like this:
      //reset home object and increment it by one
      home.reset();
      home.add(1);

    5. Re:Disagree by Anonymous Coward · · Score: 0

      Re:Disagree (Score:1)
      by JerryBruckheimer (896257) on Thursday July 21, @04:11PM (#13130306)

      Oh my god I fucking hate you.

    6. Re:Disagree by Anonymous Coward · · Score: 0

      Then: you complain to the Mozilla Foundation

  25. Explanation as a Debugging Tool by Anonymous Coward · · Score: 4, Interesting

    My friends and I have long known the power of explaining your code as a method of debugging.

    I'm not talking about walkthroughs.

    What I mean is, when you are stuck -- when you have been staring at your code for hours, but you just can't see where the problem is -- you go and explain how it works to someone else.

    It doesn't even matter if the other person is understanding, because, after just a couple minutes, the explanation usually ends something like this:

    "And in this line, we take the value that was stored up h-e-r-e... uh... wait a minute... [inaudible mumbling]... I gotta go, I'll see you later." :-)

    1. Re:Explanation as a Debugging Tool by Miniluv · · Score: 4, Interesting
      There's even a generally recognized named for this. In The Pragmatic Programmer this is called "Confessional Debugging". You are quite right about both its usefulness, and the standard usage pattern.

      In the office in which I work, people often come up and state explicitly that they need to do some confessional debugging, and it almost always works. Sometimes it requires a question or two from the listener, but thats usually the most the confessor needs.

    2. Re:Explanation as a Debugging Tool by MontyApollo · · Score: 1

      The exercise of explaining any topic, not just source code, is a good learning tool as well for that topic. Even if it just a mental exercise where you are explaining something to an imaginary listner and you try to predict what kind of questions might arise.

      I think Feynman said something to the effect that if you could not explain a topic to bright freshman in the same field, then you really don't know it that well yourself.

    3. Re:Explanation as a Debugging Tool by Anonymous Coward · · Score: 0

      This is my philosophy of commenting code. Write the comments as though you were trying to teach somebody else how it all goes together, and not only will this reveal problems in the design, before you actually write the code, but it will also stop one from writing quick hacks that are either difficult or embarrasing to justify in the comments that explain them.

    4. Re:Explanation as a Debugging Tool by bcl · · Score: 1

      Also known as "telling it to the teddy bear". The story is apocryphal (to me) but as I heard it a group of student computer consultants (read helpers) at (insert school of your choosing) had a teddy bear on a chair outside their office. Students wanting help were required to tell their problem to the teddy bear before a consultant would help them with it. Half of the students went away without talking to the consultants, having solved their own problem by telling it to the teddy bear.

      Of course it is possible that the teddy bear actually learned something about common programming problems and was giving out advice but I don't think so.

  26. Knowing how to Format a Document is Great... If... by mikes.song · · Score: 1

    Knowing how to format a document is very important. It's good to know how to use even amounts of white-space, group like items, and differentiate unlike items. If you can do all that, and remember to use sans-serif (no strikes) fonts for headings, and serif (strikes) fonts for body text, then you just might make one sexy looking document.

    None of that will help my coworkers. They need a reading class, followed by a book on how to construct a sentence.

  27. WTF is the article talking about?? by brxndxn · · Score: 0

    I don't fvcking have issues communicating apples banana blue octopus! Different hands ordain opposite monkeys but fantasy microwaves and cell phone puppies. Seriously, fighting and screaming however, beer beer beer. Beer beer beer beer beer. Just remember this, beer.

    --
    --- We need more Ron Paul!
  28. All your grammar are belong to us by rumblin'rabbit · · Score: 1
    If you can name more than one type of verb, then you may well be better sticking with your copy of The Elements of Style.
    I can't decide if that's wrong or not, but it definitely jars.
    1. Re:All your grammar are belong to us by hawkeye_82 · · Score: 0

      I think its supposed to be

      If you can name more than one type of verb, then you may well be better off sticking with your copy of The Elements of Style.

  29. I'm not worried about my job! by Tsu+Dho+Nimh · · Score: 3, Funny
    I'm a professional technical writer ... and I'm not going to worry that engineers or programmers will learn how to write so well that I'm redundant.

    However, if they could just learn to write a decent paragraph or two explaining the way their newest brain-child REALLY works, I'd be a very happy writer.

  30. Types of verbs by Alphabet+Pal · · Score: 2, Funny
    If you can name more than one type of verb

    I can name lots of types of verbs! English verbs, Spanish verbs, Mexican verbs, Japanese verbs, ...

    --
    Because you can't spell "slaughter" without "laughter"
    1. Re:Types of verbs by TERdON · · Score: 1

      Y exactamente cuál es la diferencia entre verbos españoles y verbos mexicanos???

      --
      I have a really elegant proof for Fermat's last theorem. If this sig was only a bit longer...
    2. Re:Types of verbs by Alphabet+Pal · · Score: 1

      Los mexicanos dicen los verbos mexicanos, y los espanoles dicen los verbos espanoles.

      --
      Because you can't spell "slaughter" without "laughter"
    3. Re:Types of verbs by MochaMan · · Score: 1

      Español: "No me molestes!"
      Mexicano: "No me chingues!" ;)

  31. Another good book by VeryProfessional · · Score: 1

    Writing for Computer Science by Justin Zobel is also a very good book in this area. It focuses on academic writing but has a lot of detail on how to create good figures, graphs, tables and so on.

    1. Re:Another good book by Zeos386sx-16 · · Score: 1

      and another: Pocket Book of Technical Writing by Dr. Leo Finkelstein, Jr.

      I had Dr. Finkelstein as an instructor for a CS/CEG required technical writing course.

      His book has come in handy since then.

  32. Reverse engineering code is a waste of time by Tsu+Dho+Nimh · · Score: 2, Insightful
    "Anybody working on a team ought to be able to read code and understand the internals of the machine. If they can't- they're working in the wrong industry."

    I should NOT have to reverse engineer your code to find out what it does. A competent technical writer can take a well-written software specification and have a draft user manual ready by the time the code is compilable.

    1. Re:Reverse engineering code is a waste of time by Marxist+Hacker+42 · · Score: 1

      Who said anything about reverse engineering? Just run the code in your head. It's no harder than understanding comments in English, it's just another language. A simpler one at that, for most computer langages (a notable exception is SQL with it's recursive layers of interpretation, but even that is fairly readable once you get used to it).

      --
      SJW: a person who perceives an injustice, and while correcting it, commits a greater injustice.
    2. Re:Reverse engineering code is a waste of time by Tsu+Dho+Nimh · · Score: 1
      "Just run the code in your head"

      In a very short time, often simultaneously, I can be writing user-level material for software written in C, Java, Cobol, Fortran, Python, Perl, or whatever the language du jour may be.

      "Running the code in my head" is not going to work, unless you expect me to master not only English but every other programming language in use, or that has ever been used.

    3. Re:Reverse engineering code is a waste of time by johnjaydk · · Score: 1
      Just run the code in your head. It's no harder than understanding comments in English, it's just another language.

      Sure thing. But it tends to be a bit difficult to sort out the big picture from the source code. When presented with 1E6 lines of code you are pretty much lost in the forest. You can't see anything but trees.

      Providing an outline or a roadmap makes things so much easier. Don't forget you often have to return to this code 6-12 months down the road and it really is a pain to figure out what you were thinking at that time.

      Write clear, transparent code by any means and I'll be eternal gratefull but if You don't provide some clues to how You structured the whole mess then You better check for semtex underneth Your car before You start it. This tends to get hard on Your knees after a while...

      And remember most of the time the pure sod who wrote the code 6-12 months ago is the one assigned to updating it (You touch'd it last, pal) and short term memory don't last that long...

      Been there, done that and have the scars to prove it.

      --
      TCAP-Abort
    4. Re:Reverse engineering code is a waste of time by Jimmy_B · · Score: 1
      A competent technical writer can take a well-written software specification and have a draft user manual ready by the time the code is compilable.
      Really? Most of the advice I've seen has said that the code should be compilable from day one and be compilable all the time. And "well-written software specification" isn't something one normally sees in the real world.
    5. Re:Reverse engineering code is a waste of time by Marxist+Hacker+42 · · Score: 1

      If you don't know the language, what are you doing messing with the source code at all?

      --
      SJW: a person who perceives an injustice, and while correcting it, commits a greater injustice.
    6. Re:Reverse engineering code is a waste of time by Tsu+Dho+Nimh · · Score: 1
      I don't mess with source code: I use software specs, software comments, and various builds to write user manuals.

      The "why should I have a spec/comments/whatever mindset is what I was railing against. Nobody should have to reverse-engineer or mentally compile code to figure out what it is supposed to do.

    7. Re:Reverse engineering code is a waste of time by Marxist+Hacker+42 · · Score: 1

      Correct- sufficent for creating user documents should be RUNNING THE CODE. There is NO guarantee that the specs or the comments will match what the actual code does- and thanks to you, I now see why most user manuals are so incredibly bad.

      What makes you think that the specs or the human-written, non-machine-tested comments will look ANYTHING like the user interface after 12 rounds of user testing? In my experience, specs and comments are just the starting place- by the time a project is shippable, it bears NO resemblance whatsoever to the original spec.

      --
      SJW: a person who perceives an injustice, and while correcting it, commits a greater injustice.
    8. Re:Reverse engineering code is a waste of time by Tsu+Dho+Nimh · · Score: 1
      "There is NO guarantee that the specs or the comments will match what the actual code does- and thanks to you, I now see why most user manuals are so incredibly bad."

      The preferred practice is to write a draft "as specified" basing it on the product's use cases and functional specs (WHAT it needs to do, not how it does it). Shortly before alpha release, edit the draft to match the reality, add screen shots, etc. If your final product doesn't function like the original spec quite closely, the planning stage was short-changed.

    9. Re:Reverse engineering code is a waste of time by Marxist+Hacker+42 · · Score: 1

      the planning stage was short-changed

      Exactly right- the planning stage ALWAYS gets short changed it seems- and the final round of user testing shows it with fiddling little GUI changes.

      --
      SJW: a person who perceives an injustice, and while correcting it, commits a greater injustice.
  33. Re:Disagree with the disagreer! by Tsu+Dho+Nimh · · Score: 1
    If you can't understand what I've done by my source code, then you're worthless.

    Does your source code start with a clear software specification document, and are all your mudulkes accurately and completely commented? If not ... what the heck are you coding?

  34. 1337 Speak by BinBoy · · Score: 2, Funny

    I'm disappointed with the lack of a 1337 speak chapter. How can I explain myself to my colleagues on IRC?

    1. Re:1337 Speak by Anonymous+Brave+Guy · · Score: 1
      I'm disappointed with the lack of a 1337 speak chapter. How can I explain myself to my colleagues on IRC?

      I believe a strange language known as "English" is customary in this part of the world. You may find an ancient text known as a "dictionary" to be helpful. (It's like a paper spelling checker.)

      Rumour has it that particularly skilled English speakers, sometimes called "five year olds", can even convey meaning clearly and precisely using a strange concept called a "sentence". This obviates the traditional IRC skill of replying "WTF?" to every other comment, and the occasional confusion arising from posts that were believed to be comments from a correspondent, but in fact were MD5 checksums inadvertently pasted into the chat window.

      --
      If you disagree, post your argument. (-1, Overrated) isn't your personal censorship tool for views you don't like.
  35. "On Writing Well" by holden+caufield · · Score: 2, Insightful

    Here is another vote for "On Writing Well" to bookend your copy of Strunk & White.

    Just as programmers compliment the "elegance" of code, Zinsser's focus on writing with economy is a lesson more should follow.

    --
    I'll create an amusing sig when I have something meaningful to post.
  36. What's the Point? by meehawl · · Score: 2, Insightful

    I think it's a bit of a wasted effort for engineers to try to learn to communicate in English past a certain level. A college freshman scientific writing/essay course should be sufficient. Unless, of course, they are career changers and *want* to move into technical documentation. Usually, though, the tendency is to move in the other direction.

    Your time and their time is much better spent formulating some good process documents, so you can get busy herding them into producing functional specs, and getting them to review and to sign off on engineering requirement documents, and so on.

    After all, nobody expects the tech writers to seriously produce good code, or the tech support people to go out there and do the marketing.

    --

    Da Blog
    1. Re:What's the Point? by Tsu+Dho+Nimh · · Score: 1
      " I think it's a bit of a wasted effort for engineers to try to learn to communicate in English past a certain level. "

      The hardest thing to write is a clear, concise explanation ... I've been a technical writer for 20 years or so and I'm STILL LEARNING. However, the core techniques of writing non-fiction can be taught fairly quickly.

      I'm afraid that the book's author may have spent a lot of time on layout, which is probably something better left to a professional.

    2. Re:What's the Point? by patio11 · · Score: 1
      I worked with many intelligent engineers at one job and by the end of the second month was delivering most of the powerpoint presentations because they had never, in their professional careers (the shortest of which started when I was still watching Transformers) learned how to explain technical concepts to a non-technical audience. We had one brilliant professor whose idea of a demo was to have scrolling output from a unix script running by at the computer's maximum speed -- he assumed that since he could parse the output (having written the script and knowing what the pattern would look like when it was operating effectively) that an audience who not only didn't know what the script was doing but didn't even know what the larger project was designed to do would be able to follow it. And you can just forget getting an adequate description when one of the decisionmakers asked for specifics -- to a man, all the engineers either said "You wouldn't understand it" or started a l33tspeak throwdown that I had difficulty understanding and I was part of the team that just implemented the algorithm.

      Blaaaaaaaaaaaaaaaaaaaargh!

      Anyhow, your take home message from this post is: It is not wasted effort to learn to communicate effectively in spoken and written English (or, for that matter, any other language you can communicate with a customer in).

    3. Re:What's the Point? by writingdoc · · Score: 2, Informative
      A class you took as a first-year college student is not going to help you much when you start working and trying to a) learn new technical stuff in a real work environment and b) communicate it to people without your expertise. Sorry, but that's the "great writing inoculation hope." It's been a hope for a long time, and it's never panned out (see David Russell's book Writing in the Academic Disciplines if you'd like a detailed history of just how long people have wished this were true, and just how much it's not). If you want to be a good writer, you'll have to keep on practicing (ie, writing) and learning how to write in and for new contexts.

      For me to hear you say that engineers don't need to communicate clearly is, frankly, scary. There are some great (yes, academic) articles out there tracing just how badly things can go wrong when engineers don't communicate well. One such article is pithily titled "Communication: The missing link in the Challenger disaster." Another is called "Understanding failures in organizational discourse: The accident at Three Mile Island and the Shuttle Challenger disaster." You get the idea. Good communication is everyone's responsibility, no matter how much my engineering students wish it weren't.

  37. Maybe I'll use this book... by Ecko7889 · · Score: 1

    Maybe I'll use this book in Writ 1E in college. A special writing class desgined for illeterate engineers like me :-)

    --
    $sig$
  38. Re:One problem / Technical writing by securitas · · Score: 3, Insightful



    The very best technical writers I've known were highly skilled writers with a rare ability to take highly complex and technical subject matter and communicate that information in simple (but not simplistic) and clear terms at the level appropriate to their audience.

    Their most common complaint was that management (typically with engineering backgrounds) in the R&D operations that they were part of discounted or denigrated their role and contributions to products, instead of regarding them as the skilled usability professionals they are.

    I don't know how many serious usability issues and critical bugs have been detected and resolved as a result of the work of those technical writers.

    At a technical content review for an alpha-stage product line I saw one operations director who defined good documentation by the numbering system. Because the technical content was flawless, the only criticism he could come up with was, "Where's the numbering? Everyone knows that good documentation has to have good numbering!"

    He followed that up with some comment about being short-staffed for developers on the team and "helping" the docs specialist by tasking some developers to take on future technical writing tasks. In other words, he was trying to get his developers take over the technical writing tasks and get rid of the docs specialist altogether. The only reason he felt he could do this was because of the attitude that anyone can write, and any developer who can write can also write good technical documentation. Unfortunately that attitude tends to be typical of many engineers.

    While a book like this is definitely a great help to developers and scientists who want to improve their ability to communicate their ideas, I wonder how many managers of the sort I've described will use it as a tool to devalue the work of professional technical writers.

    Just because you can write, it doesn't mean you can write well.

  39. Re:Disagree with the disagreer! by coflow · · Score: 1

    I thought it would be apparent and maybe painfully obvious from the context that I wasn't serious. It's not like normal every day users ever get to see source code, and they're ostensibly the ones who need documentation.

  40. Speaking of typos... by GPS+Pilot · · Score: 1

    While there are many books that teach written skills...

    I'm pretty sure the submitter meant "writing skills."

    --
    That that is is that that that that is not is not.
  41. From the anals of technical humor by eldeezimberdwock · · Score: 1
    1. Re:From the anals of technical humor by Dystopian+Rebel · · Score: 1

      Just in case you did ~not~ mean "annals", I am not going to click your link.

      --
      Rich And Stupid is not so bad as Working For Rich And Stupid.
    2. Re:From the anals of technical humor by Anonymous Coward · · Score: 0

      It's ok, the link points to the Usenet rec.humor.funny archives. Here's the text:

      The Society for Technical Communication (STC) released its
      annual Report on the Status of Technical Writers today. This
      report, issued by the STC's Writers' Committee on
      Technical Scribes, monitors the civil and human rights of
      technical writers throughout the world and documents abuses
      against them. It also includes a handy quick-reference guide
      to basic Fortran compiler options.

      Overall, the report noted that the situation for technical
      writers the world over is "precarious, and, in many cases, is
      worsening rapidly. In particular, writers in the Third World
      routinely live in poverty and squalor." (The report noted that
      this may apply to other people in the Third World as well.)

      The report concludes:

      To the twin I-beams of Democracy and Freedom one may
      add those of Technical Accuracy and Good Visual
      Layout. But these too are threatened by mankind's
      age-old nemeses: Bigotry . . . Hatred . . . Right
      Justification. If the human race is not only to
      survive, but to prosper in the heart and in the mind
      and in the soul, technical writers must practice their
      ageless craft unencumbered by fear, privation, or
      schedules.

      Some of the highlights of the Committee's report include:

      o Worldwide deaths involving courier font have increased
      9% over the past two years.

      o Canada recently passed legislation making the passive
      voice the national language.

      o In China's remote Dimsum province, oxen are used in
      place of technical writers, with no apparent loss of
      readability.

      o In North Korea, police departments no longer use electric
      cattle prods to torture dissidents, replacing them
      instead with extremely slow and finicky daisy wheel
      printers.

      o The Frame Technology Corporation now touts its product
      as "disposable."

      o Torture of technical writers by roving gangs of
      hooligans known as "editors" is rampant in Northern
      Ireland, where sectarian violence between different
      spellers of "filesystem" runs out of control. One
      particularly gruesome form of punishment is "chopping":
      holding a writer down and then cutting the dangly
      thing off his cedilla.

      o A similar practice is "stet-ing," the continual removal
      and replacement of chunks of text, leaving the
      writer dazed and confused. (Or more dazed and confused,
      to be exact.)

      o A worldwide shortage of #2 pencils has left many
      technical writers in poorer countries unable to
      take notes or doodle during meetings--forcing them
      to pay attention or end the meeting by flinging
      live poisonous insects at the other attendees.

      o The Baath Socialist party of Syria has introduced the
      use of cuneiform stone tablets, which jam PostScript
      printers.

      What can you do? Lots. Send a letter to the head of government
      of one of the cited countries; include a diagram with mixed fonts
      and at least one incorrect cross-reference. Show them you mean
      business. Or write to the UN High Commissioner on the Status of
      Technical Writers, stating that you are categorically opposed to
      the use of mustard gas during staff meetings and that you're
      still having problems figuring out which way the darn CD is supposed
      to go in. Or you can have a fundraising party, inviting all your
      technical writer friends and promising them that if they give
      a donation to Save the Tech Writers you'll cancel the performance
      art you had scheduled for the evening.

      A copy of the report is available from the Copy Center and
      from your local samadzat.

      --Mateo Burtch

      (c) 1992 Mateo Burtch
      Yes, you can forward this; just keep my name attached to it
      or I'll publicly link you with Ron Reagan.

  42. "Techinical?" by Anonymous Coward · · Score: 1, Funny

    It looks like there's at least one word the class didn't help you with :)

  43. The Problem With Technical Writing by TheBillGates · · Score: 2, Insightful

    Most technical writers do not write as they speak, and they do not write in simple step 1,2,3 steps.

    I wrote many maintenance manuals in the Air Force and my coworkers never had any problems following the procedures in my manuals. The secret to authoring an effective technical manual is not rocket science. Write as you would speak, and have simple 1,2,3, etc steps. The average reader will not have any problem understanding your writing. And yes, I did not run this through a grammar or spelling checker. I write as I speak.

    1. Re:The Problem With Technical Writing by Anonymous Coward · · Score: 0

      One problem with your technique...your users will never know how to do anything but the 1,2,3 steps you define. I believe good technical writing must ALSO explain concepts and best practices, not just how-to steps.
      I'm constantly amazed at how so much of the "documentation" I see are "recipes" to solve a few common problems, none of which are my particular problem.
      The best technical writers have a real professional-level skill that allows them to conceptualize difficult architecture and functionality in a simple, useful way and communicate it to end-users so the users help themselves.

  44. Amen, brother! by FunWithHeadlines · · Score: 1
    As an ex-programmer, now technical writer too, I know exactly what you are talking about. Can anyone read a book on programming and become a programmer? Pretty much. How good a programmer will most of those people be? Average, or not very good at all. You have to have a certain mindset, a way of thinking that allows for clean code. If you don't have that, you can learn the language and some algorithms, but your code will never be a joy to work with.

    Same thing is true of writing. More so. It's amazing how often companies think anyone can write. Why, it's only the language you speak so how hard could it be? Why I could whip out a manual in no time...if I could just get past this project...and then I need to clean my desk...ah, lunch time calls...etc. The manual never gets done. Or if it does get started, they quickly learn how intimidating a blank screen is when you are the one expected to come up with the next sentence.

    Don't get me started on what managers write. Their emails are astounding. Astoundingly bad. But that's not atypical in the least. Most people know how to communicate, but not in writing. So enter the technical writer who can do all of the writing that needs to get done, on time, to spec, with good quality. As you said, I'm not in the least worried that some programmer is going to take my job. I can't even get them to write an email telling me what they want me to write. They are so afraid of writing, they would rather tell me on the phone what they want and let me take the notes!

  45. Re:Disagree with the disagreer! by Tsu+Dho+Nimh · · Score: 1

    We were discussing the need for technical writing skills on the part of programmers and engineers ... and unfortunately, the "read my code" attitude is alive and well in the OSS community.

  46. Explanation of *how* things work is crucial. by chris_7d0h · · Score: 1

    This seems like an excellent book and subject.
    The industry is in dire need for more people to write for the *need* of other people.

    Two current examples.
    My company employ one of the big development methods, aging back some 10-15 years. It contains templates for various (document) deliverables the company pitch as an advantage to customers. These documents (ranging from 80-500 depending on the project) are something each project spits out *just because* they have to (lousy project management). The decision of what document deliverables to produce is made something like 1-2 years ahead, which in reality means only 5-10% of them would be useful at the date of shipping.
    Instead of having all these tens of thousands of useless crap pages being manufactured, junk which no-one will ever read, it would be much more appropriate if the right people could write about the right thing in a way suitable for the intended audience. Unfortunately this would mean a break from the *method* at various point which seems unlikely at present given the particular company culture. In short, Agility needs to enter the "document manufacturing" cycles as well.

    The second example has to do with with doers vs. explainers (is that a word?).
    I've run some projects in which we had some brilliant designers and coders, creating the most flexible and elegant designs and implementation. Unfortunately these people either didn't document them or documented them poorly. On each account I took the decision to simply yank the undocumented or poorly documented "elegant" stuff out of the system replacing it with something which average developers were able to explain and understand. The decision might have resulted in worse design, but who really knows. A customer who is going to maintain a solution deserves to be able to understand the architecture and design without having to hire A-grade coders and getting them to document the stuff (fat chance of getting A-grade coders who also document except for "Gamma or Beck"!).
    This culture of *just read the code* isn't flying today and brilliant people who can't express themselves are finding themselves having a harder time getting new project contracts.

    --
    In a society that believes in nothing, fear becomes the only agenda ~ Bill Durodié
  47. Tech Writing Rant by bossvader · · Score: 2, Interesting
    I am a Development Manager who came up through the ranks and have a wife that is an excellent Tech Writer. Here are a few of our observations...

    Many developers (not mine of course), especially in poorly managed and I mean both poorly tech and people managed departments treat Documentation as Chore and Necessary Evil, and Quite Honestly treat the Tech Writers like s#@t. The developers don't want to provide guidance, provide content and review docs. The managers are afraid to put thier foot down on thier "talented whiners" so it becomes OK. And then they throw in the Agile Manifesto, to try to justify it.. you know code over documentation... agghhhh it drives me crazy... not the Product Documentation you Moron! In the end it is the product that suffers.

    These are the same developers that then turn around and complain about crappy documentation in the tools and platforms they use.

    Finally I don't buy that "Engineers are poor writers by design". Step up to the plate Maynard! and learn to read and write!

    As others said engineers that learn to write and communicate become much more valuable, and have a greater chance to effect the process. If you don't like what your manager is saying, learn to communicate your ideas effectively. Its up to you to be your own best advocate.

    -Steve

    1. Re:Tech Writing Rant by tuxette · · Score: 1
      I am a tech writer now; I wasn't one until very recently. Anyway, here's my experience in the company I work for:

      - I am treated very well.

      - The developers are sweethearts and go out of their way to help you out when you don't understand something. They are very cooperative, helpful, and good communicators.

      - The developers, though non-native writers of English, write excellent notes and reviews.

      Maybe I'm just very lucky, maybe it's a cultural (both country and corporate) thing. We all seem to have this "we're all in this together" attitude going.

      But one thing I've noticed here, aside from the team spirit (not so sure about the management yet) - everyone seems to have good "chemistry." I don't mean it in the romantic way (even though there are lots of good looking guys here). Everyone here seems to naturally get along. No awkwardness or hostility or anything. I think this helps things a lot...

      I also must say that my company is doing very, very well. It just keeps expanding and making money.

      --
      People say I'm crazy, I got diamonds on the soles of my shoes...
    2. Re:Tech Writing Rant by mutterc · · Score: 1
      How did you break into the industry? I've been considering it as a (slightly more) offshoring-resistant (not -proof, of course) career with respect to software development. I can kinda write good, as well, and really wouldn't mind a career in documentation.

      Aside from getting 5 years of FrameMaker experience, anything else you could recommend?

  48. I hate to break it to you... by rk · · Score: 3, Informative

    but if your code work does not either cut expenses or add revenue to your employer/client by at least the cost of your labor, expect to be out of a job soon*. That's all "value added" really means.

    Also, comments matter as much if not more than the code. I'm not talking about stupid crap like:

    i++; // increment i

    I've seen stuff like that, and it's worthless. But real comments stating what problem you're trying to solve, and how you're solving it. Without that, what's to say the code is right or wrong? It's so easy to duff up a complex condition with misplaced punctuation or an AND in place of an OR. Explaining this condition in the code will help yourself and others understand what you mean when the code isn't quite saying it. Meatspace is still the Real World(tm), no matter how much we might wish it were otherwise.

    * - an obvious exception is basic research work where it's pretty hard to quantify the value of what's done. Another exception is stuff one writes for the pure joy of it.

  49. Tech Writers Needed by djupedal · · Score: 0, Offtopic

    This is a serious request for experienced technical writers willing to consider living and working in China. This means 5 years or more experience, with telecom industry experience preferred. Native English speakers only. No interns need apply, etc.

    Please contact Ken at kmtkr@hotmail.com

    Note there are currently three job openings at this level.

    As for the book, I agree with those that see the value in the subject. I also agree with those pointing out that tech writers have little to fear from engineers suddenly becoming adept at writing for people outside their sphere. With most engineers believing that everyone speaks the way they do, good tech writers can look forward to long and prosperous careers.

  50. Re:Disagree with the disagreer! by coflow · · Score: 1

    Not just in the OSS community, and that's why I figured I'd make a joke about it. But judging from the overall responses and the late troll modifier, it wasn't taken that way.

  51. Prose by pete-classic · · Score: 1

    Simon,

    I think prose means the opposite of what you think it means.

    -Peter

    1. Re:Prose by aaribaud · · Score: 1

      Well, the link gives two meanings to 'prose'.

      You probably only considered the first one (the common manner of writing). What if Simon referred to the second one (a specific to a style of poetry)?

      (And even the first one might not necessarily be the opposite of what Simon thought it is: he might have wanted to stress the idea that tech people don't want to write text, as opposed to writing code.)

    2. Re:Prose by pete-classic · · Score: 1

      I suppose that in an infinite universe anything is possible.

      Did you not notice that the defining characteristic of "prose poetry" is that it doesn't do the things we expect poetry to do; that it, in fact, is like common writing?

      -Peter

  52. Amazon Link by Anonymous Coward · · Score: 0

    You can buy it here too: Spring into Technical Writing

  53. Do It Yourself Documentation by R33MSpec · · Score: 1

    I generally use this service when writing technical and other documentation for work. It's more slanted towards bulk documentation for commercial areas but it allows me to plan a document and get a quote very easily. You can also convert your existing paperbased manuals to online as well.

  54. Comment removed by account_deleted · · Score: 1

    Comment removed based on user account deletion

  55. I live this. by Anonymous Coward · · Score: 0

    I am likely to low to get in any way seen, but this is what I do as a college student. I am a dual major, Computer Engineer/Professional and Technical Writer, with personal training and coaching from a project management/teambuilding guru. What my team is currently working on, through an National Science Foundation Grant, is a way to introduce, team building and Technical Writing training seamlessly into the first two yearss of your college career.

    We are publishing our findings in a book, which'll probably be sometime in the next 3 years, after we try a few more tests against some more control groups in more diverse courses.

    In my opinion it's imperitive that todays engineer get training in Writing, and in teambuilding. No longer are engineers stuck into cubicles to work long hours in solitude. They are in small teams, bouncing ideas back and forth, really tackling problems in a diverse manner, and if they don't know how to handle the occasional sour grape in a team, their first few years as a professional will be hectic and stressful, even moreso than it already is.

    Now, I happen to be a lucky person, the things I'm doing now more or less fell right into my lap. I'm only going into my Sphmore year of college, and already I have a hand in the design and implementation of a full-blown real curriculum. A curriculum for a class that I'll be taking as we implement the changes.

    The thing is, more schools need to pay attention to their undergrads. Most big tech schools, where most engineers graduate from, don't have the enviroment I have being in my medium sized University. The school, and it's professors need to take the time to get these grants and pilot their own programs, or learn from the methods disseminated from pilots like my own. Otherwise the industry is just going to keep heaping barriers into the entryway of the engineering feild.

    1. Re:I live this. by Ahkorishaan · · Score: 1

      Would someone mod up the parent. It contains some pretty relevent information considering it's modded as a 0...

      --
      Please, try not to sound so stupid...
  56. Thanks for the direct link to bn.com, but... by mattwarden · · Score: 1

    the book is US$4 cheaper at Amazon.com.

  57. Couple of links by JerryP · · Score: 2, Informative

    If you're interested in the book's subject, you might find the following links usefull:

    Technical writing tips: http://www.docsymmetry.com/index.html

    Plain English Campaign: http://www.plainenglish.co.uk/index.html

    Get it write: http://www.getitwriteonline.com/archive/tips.htm

    1. Re:Couple of links by HWheel · · Score: 1

      Unlike the link to the horrible diy-doc site above, I'm rather impressed by docsymmetry. It's more basic than I can use (as a professional tech writer) but it's a nice site with the solid information taught at the college level. I can refer other people to it and will point it out to a couple of friends in the business. Thanks.

  58. The King's Singing Horse by meehawl · · Score: 1

    It is not wasted effort to learn to communicate effectively in spoken and written English

    But how much effort might be required to raise the standards of written communication within people whose time might be better spent doing what it is that they do best? My point is that the effort might be too much, and too distracting, and ultimately futile because the tech writer is still going to have to rewrite it all anyway. There's a reason why "division of labour" works so well in a large enterprise.

    Are you familiar with the story of the King's Horse and the man who promised he could get it to sing?

    --

    Da Blog
  59. Sweet word "mudulkes"! by Anonymous Coward · · Score: 0

    Heh, how you do that?

    You use that word "mudulkes", which I enter into google looking for an explanation. Google says they never heard of it, but do I perhaps mean "modules"?

    The word modules lets the sentence make sense. But how did the poster know google would interpret it that way, if google has "never seen" that word before??

    Puzzlement here. :-)

    1. Re:Sweet word "mudulkes"! by Tsu+Dho+Nimh · · Score: 1

      I'm a writer, not a typist ... and Google is a much better speller than I am. :) Google has some way of detecting common typos that are based on keyboard layout. Double-strikes, where you hit both keys, off-sets where you are touch-typing one key to the left ... it's really nice.

  60. Miniluv, your blog .... by Anonymous Coward · · Score: 0

    ... has become a comment spammer's paradise.

  61. What helped me... by M.+D.+Nahas · · Score: 1

    This paper is on the web and helped me to an amazing degree: "The Science of Scientific Writing" http://www.amstat.org/publications/jcgs/sci.pdf If you're looking for help on fixing little things: "Bugs in Writing"

  62. why writing *really* is important by Anonymous Coward · · Score: 1, Insightful

    S/he who writes the proposal, controls the money and the project. It's that simple folks.

    And it's not just the *form* of the documents. It's the arguments why you're right, they're wrong, and you should get every dime they have. There's more to this than simply describing what you did with the belief that as soon as people see your description, of course they'll come flocking to your way of thinking.

    Technical writing is more of a war of ideas than anything else. Not only do you have to show your audience you are correct, but you have to address all the hidden questions that they have to convince them that you are correct. Otherwise, what good has all your work been if you can't get others to believe in it?

  63. Dreary and poorly presented web service by HWheel · · Score: 1

    This seems like a horrible "service." I can't tell what's going on or what I'll get or even vaguely how long it will take or what it will cost. I'm afraid that this service fails the basic rules of tech writing (and user interface) on so many levels.

    And I hate it when writers use "commence" instead of the easier to understand "begin." Ugh. All of the prose seems overdone and yet not helpful.

  64. Confusion about tech writing vs comments in code by HWheel · · Score: 1

    While I generally agree with you, tech writing is about creating solid usable material (and removing the fluff) in user and reference materials, not about adding comments in code.

    I think that commenting on code is a valuable skill, and I recognize that some developers do it like an artist while others do it like a stinky child, but commenting is very different than tech writing, which includes determining the audience for a document, outlining it, and then building it so that it can be used, updated, and re-used. (I'm purposely using programmer words that a developer might understand.)

  65. User Training for Busy Programmers by software_trainer · · Score: 1

    Shameless Self-Promotion: If you're a programmer who needs to write a user manual, the book reviewed here sounds like a great fit. But if you need to write a training course for the application you've created, check out my book, User Training for Busy Programmers. It gives you step-by-step instructions for developing an instructor-led software class. It takes a practical, condensed approach for when you don't have time to learn training theory.

  66. Re:One problem / Technical writing by nrrd · · Score: 1

    It's sort of like thinking that just because you know how to use Word, you should be able to write like Shakespear...

    --
    "Eye halve a spelling chequer, It came with my pea sea, It plainly marques four my revue, Miss steaks eye kin knot sea"
  67. how to start after doing other things by tuxette · · Score: 1
    Very simply - start writing stuff. Documenting Open Source projects is a great way of getting experience and building up a sort of portfolio of proof that you actually can write.

    Once you have something to show a potential employer, start applying for jobs.

    --
    People say I'm crazy, I got diamonds on the soles of my shoes...
  68. Hell no by mochaboy · · Score: 0

    I am a technical writer. I can say, without a shadow of a doubt, that most of the elements of style are proscriptive bullshiite. Besides, writing for Law or business is not the same as writing for tech.

  69. Read Closer by meehawl · · Score: 1

    For me to hear you say that engineers don't need to communicate clearly is, frankly, scary.

    Why don't you point out where I said that? Communication is a two-way process. It requires comprehension as well. I said "past a certain point". Implicit in my argument is that people are able to communicate in such a way as to obtain a passing grade in a college-level language composition class. With that skill, any reasonably able person should be able to learn to communicate effectively the systematics of their project as it grows in complexity. That is why I said that process, and process documents, and training convincing engineers to use process communication document templates, are more critical and more useful than spending time sending engineers to technical writing classes, or seminars.

    The disasters you describe did not stem from a lack of language composition skills and probably could not have been avoided no matter how many skilled technical writers could have been deployed. They stemmed from classic structural problems and chokepoints within the organizations. The information was well composed and available, but its gamut, dissemination, and flow within the management hierarchy was impeded, and in many cases stifled, by political and personality issues. That is what is used in communication studies when you talk about "discourse": the power politics of communication. Who is saying what to whom, and why. All the well-structured sentences and beautifully coherent essays in the world can't prevail against emplaced, willfully ignorant managers with conflicting agendas. As an example, I refer you to the USian head of state, George W Bush. A woefully bad communicator against whose policies many, many well-reasoned arguments have been advanced, but have proved ultimately futile. It's all about creating a Reality Based Community, and that is done in deeds, not in words.

    --

    Da Blog
  70. YES! by Rick+and+Roll · · Score: 1

    YES! People who can't write or speak well also don't have a good understanding of the concepts. It's just the way it is, and the way it has to be.