Jacob Kaplan-Moss: writing

Bookmarks

“If you accept — and I do — that freedom of speech is important, then you are going to have to defend the indefensible. That means you are going to be defending the right of people to read, or to write, or to say, what you don't say or like or want said.”

(censorship, comics, essay, freedom, freespeech, law, neilgaiman, politics, speech, writing)

Threepenny Planet: Muphry's Law

“Muphry's Law dictates that if you write anything criticizing editing or proofreading, there will be a fault of some kind in what you have written […]”

(funny, law, proofreading, writing)

Rands In Repose: The Coffee Mug Affair

Rands is starting to remind me of a geeky Haruki Murakami, documenting the minutiae of daily life in glowing prose. Naturally I love it.

(coffee, dailylife, minutiae, writing)

idiosynchrony

My friend Jocelyn Rice has just started a blog. She's an amazing writer; if you like good science writing, I suggest you check it out. Who knew there was actually an established formula for calcuating the surface area of an elephant?

(friends, science, writing)

Rands In Repose: The Gel Dilemma

This is why Al Gore invented blogging.

(pens, writing)

Mike Davidson: A Low-Fi Solution to E-Mail Overload: Sentenc.es

Really, really tempting.

(culture, email, lifehacks, writing)

DocBook

(book, docbook, writing, xml)

Entries

You need an editor

If you really want to produce great documentation, it needs to be edited.

(django, documentation, editing, writing)

Technical style

How to develop a great technical writing style.

(django, documentation, grammar, style, writing)

What to write

Tech docs can take a bunch of different forms ranging from high-level overviews, to step-by-step walkthroughs, to auto-generated API documentation. Unfortunately, no single format works for all users; there’s huge differences in the way that people learn, so a well-documented project needs to provide many different forms of documentation. This is the first in a series of posts that’ll cover the art of writing good technical documentation.

(django, documentation, writing)

Jacob Kaplan-Moss

Activity tagged “writing”