Live data from Hacker News

Please learn to write

randsinrepose.com

61–70 of 124 posts

Re: Please learn to write

#61
Many people are commenting that writing improves with practice, and that's true, but it probably isn't enough. The 10,000 hours count only if they're done well. I'm not a writer but here are some basics I've found helpful.

1. Revise constantly. If you haven't revised it three times you almost surely haven't done enough. You don't need an outline, but as you write new thoughts will occur to you, previously open questions will be answered, opinions of priorities will shift. Writing in the Rubber Duck school of programming to the nth degree. All that you discover you already knew should be completely reflected in the final document. This is a very painful thing, you can spend hours on something and be "almost done" when you realize the key question on which all depends, the answer to which requires a complete rewrite of the document.

Note that "revision" often means changing the purpose of the document. You can go from reporting status to asking about key variables driving that status. Text may not be the right medium for the new message.

2. Edit ruthlessly. Everything can be shorter. The time you take clarifying and shortening saves your readers that much and more -- since you, not they, are best positioned to solve the puzzles posed by an obscure sentence, and to summarize an overly long one. If your readers number more than one, the time savings are multiplied.

3. Be very clear in your terms, meanings and references. If they aren't clear, explain them. Did that explanation just blow up your document's organization? Time to revise. Be precise. Your audience does not have your perspective -- your local environment variables are not theirs -- you need to orient them to the topic before you can expect casual references to be meaningful.

4. Much business writing requires an imperative style. At the top, tell your reader the action or decision expected / hoped for of them at the end of the document, and tell them what you will talk about. As you provide information, keep it in relation to the action expected of them. If there is no relation, what is it doing here? If it must be in here, why? and what are the implications for the stated purpose of the document? Is it time to revise again?

At the end of the document, give them detailed instructions about what they should do next -- call at this number, email that address, provide these thoughts, whatever.

Good training in writing is available and worthwhile. If you really want to get better, seek it out.

Re: Please learn to write

#62

Earlier quoted context omitted.

Absolutely other fields use their "abilities to make their abilities easier". As a coders we live in abstractions and you should be seeing them everywhere. Writers work with words, but some smart writers invented sentences as tools to help structure them. Some other writers invented paragraphs to structure those sentences. Some even smarter writers invented novels, short stories, screenplays, etc. These are all tools…

Short stories, screenplays and novels are definitely not tools, since you don't build stuff with them, they are finished works, and if you want to make another one, you have to start from scratch. I'd argue there are more similar to frameworks, but less powerful, since the structure of a novel only gives you a basic idea of how the end product should look, instead of doing any actual work for you.

The novel, short story and so on are absolutely tools used to build things[1]. So are genres (sci-fi, fantasy), narrative modes (free indirect discourse, stream of consciousness), and even rhythms or styles (see the Oxen of the Sun episode of Ulysses for an extreme example). Concepts are generative: if you decide to write a Künstlerroman, a lot of the heavy lifting is done for you.

That said, a single writer can't, as a general rule[2], "use [their] ability to make using [their] ability easier" in this way, since genres, modes and the like don't "just work." Even when they descend from the work of one or a few innovators, there's a long process of consensus-building that has to take place before new concepts become conventional and, as a result, productive.

1. The screenplay (for both film and television) in particular is structurally very rigid, although slug lines and such admit more variation than most people think. And the actual writing is capable of great variety. Check out the original Alien script (http://sfy.ru/?script=alien) or the Alien-inspired style of WALL•E.

2. Though of course it happens: T. S. Eliot, Ezra Pound, James Joyce, et al.

Re: Please learn to write

#64

Earlier quoted context omitted.

Did I just end that sentence with a preposition? A preposition is a perfectly acceptable thing to end a sentence with. Seriously. If you find yourself re-writing it as "with which to end a sentence" you're going to come across as stilted and awkward.

Unless writing for a scientific journal, or some other such formal setting, your goal of clear communication will be best served by using a casual, conversational style that resonates as closely as possible with how you would talk to your reader in person. That means prepositions are very much something you can end a sentence with. And you can start one with a conjunctive too, if it feels right. The rules of grammar…

All is dependent on audience.

Re: Please learn to write

#65
post #59
post #23

Source of my problems: design issues 5% architecture constraints 5% language shortcomings 1% mental blocks 5% personal time management 4% personal energy 5% communication with others 75% I waste more time just trying to figure out what others are trying to say, sometimes in person and by voice, but mostly in writing. For most emails, I have to click "reply" or call back simply because what you're trying to tell me is…

This is exactly why Jeff Atwood was wrong. If you can solve your own problem instead of having to communicate it to someone else, you've taken away 75% of the impediment to a solution.

All dependent on context. In the context of a team, one can rarely solve all problems by herself. More importantly, it can cause greater disfunction when work isn't coordinated/communicated appropriately. The whole point of working in a team is to get more work done more efficiently because the work load is shared and each member focuses on her specific skill, and doesn't do everything.

Re: Please learn to write

#66
post #23

Source of my problems: design issues 5% architecture constraints 5% language shortcomings 1% mental blocks 5% personal time management 4% personal energy 5% communication with others 75% I waste more time just trying to figure out what others are trying to say, sometimes in person and by voice, but mostly in writing. For most emails, I have to click "reply" or call back simply because what you're trying to tell me is…

I think you hit it on the head. I'd break down the 75% a little further in my case:

- 25% Poisonous people in key architectural/infrastructure positions who actively make it as difficult as possible to communicate.

- 15% "Mea culpa". I fail to clarify or make an assumption due to busyness, lazyness or missing something.

- 25% Folks who do not take initiative to engage in conversations at the appropriate time. These folks typically pop up with 11th hour critical path problems.

- 35% General nonsense: People incapable of writing english, etc.

Re: Please learn to write

#67
Maybe the thought of people who do know how to communicate, such as Mayor Bloomberg, learning to code is bothersome to Jeff Atwood. If so, consider why.

My concern is that Bloomberg is just looking for money. He may have no interest in how a computer works.

If he could code, what sort of programs would he write?

For example, with respect to the desktop and the web, many "coders" write programs that are a constant game of manipulation of naive end users. The moral issues raised in programming are seemingly endless. It's relatively rare to find a programmer with a social conscience. Mainly because few people with a social conscience know how to program.

Would people like Bloomberg bring a greater sense of social conscience to programming? Or would they worsen the situation?

On the flipside, having more people be more familiar with programming might reduce the amount of manipulation that is possible. More people might start demanding and reading source code. That could be a positive force.

Re: Please learn to write

#68
This is the most valuable thing I've learnt during my PhD. PhD teaches you:

  research skills                                     50%
  ability to communicate your research to others      50%
In my experience, I've noticed a lot of very smart hackers to be woefully bad in communication, and PhDs to be much better than the median at it. On the other hand, I think there is no correlation between research skills and having a PhD.

Re: Please learn to write

#69

Many people are commenting that writing improves with practice, and that's true, but it probably isn't enough. The 10,000 hours count only if they're done well. I'm not a writer but here are some basics I've found helpful. 1. Revise constantly. If you haven't revised it three times you almost surely haven't done enough. You don't need an outline, but as you write new thoughts will occur to you, previously open questi…

I've found some of the best training available is in discussing controversial subjects (like religion) with a mixed, but curious and respectful, group. The biggest drawback is that it's hard to find such an audience.

One of the best forms of training this circumstance provides is immediate feedback any time you fall short. If you're not clear in your terms, meanings, and references people will respond with misunderstandings. If you're too verbose, they may not respond at all. If your writing is poorly structured, they will be confused as to what point you were trying to make. And if you do a good job, you'll get meaningful and interesting comments and criticism, which will help you refine your ideas and be better able to write about them in the future.

Re: Please learn to write

#70
I often find it annoying in writing and in speech when people don't know the correct technical terminology for an idea they are trying to express, when they ought to.

Believe it or not, there are people out there that write Objective-C, for example, and don't know what an "instance variable" or a "class method" are by name.

Post reply on HN