pycon logo

PyCon 2011 Atlanta

March 9th–17th

Log in or Sign Up

Tutorial Schedule | Conference Schedule | Talks and Panels | Posters | OpenSpaces

import human

Who cares? What's writing got to do with code?

  • I want to blog about this module - not enough people know about it.
  • Dude, your documentation needs something... it sucks...
  • Wow, what you're doing completely [harms|saves]... <<flame wars ensue...>>

Documentation - a blueprint, or an afterthought? (A bit of both - iterative.)

Details can change the impact of your writing. C'mon out, bring your code - we'll try to get a handle on some of this, while writing a blog-length piece.


Friday 6:00PM - 7:05PM (Parts 1 & 2)

Saturday 6:00PM - 7:00PM (Part 3; then off to the Testing BOF!)

(only if 6 or more people show)


If you're coming, put your name below

  • Yarko Tymciurak
  • Anand Chitipothu

What (starting suggestion)

Part-1: Essential Ingredients

  • create a checklist to use while writing (~15-20 minutes; I'll seed);
  • write (individual; ~20 minutes);

Part-2: Editing

Zinsser's excellent book, "On Writing Well" will start a basic checklist for a first edit (you'll add to the checklist).

  • pair-up, run the edit checklist (~20 minutes, 10 min. on each piece)


Part-3: Anonymous Readings (~an hour)

I experienced this in a fiction writing workshop. Sort of like "debugging," but for writing. Requires an audience - you watch how they react. You take notes for your 3rd revision.

Spurred by Brian Jones' discussions on technical writing (, Steve Holden suggested a writing exercise.

openspaces/importhuman Recently modified by anandology: March 11, 2011, 7:03 a.m. (History) Edit