Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / social media / STC2008 – Writing as an Asynchronous Conversation

June 3, 2008 by annegentle

STC2008 – Writing as an Asynchronous Conversation

I had high expectations for Ginny Redish’s talk at STC this year, and she did not disappoint. It was wonderful to have my ideas about conversation and technical communication vetted and couched in academic terms such as linguistics, pragmatics, and so forth. Here are my notes. Please let me know if this is useful to you and if you have any suggestions for my liveblogging skills.

Writing as an Asychronous Conversation
Ginny Redish

Our conversation is synchronous – at the same time.
The term Asynchronous means at different times.

Book = Letting Go of the Words

Conversation as a theme for all we do as technical communicators.

Asked – how many of you have a different degree other than technical communication? Nearly everyone raises their hands. Ginny’s background is linguistics.
Exploring – all the new social media ways that technical information is shared through written conversations – participatory media as discussed by Harold Reingold in the keynote session

Boundaries – not discussing Skype or VOIP (it’s synchronous and it’s not written, it’s voice), not talking about IM or chat because it’s synchronous, not talking about AI (computers talking, Eliza).

Think about a recent trip to the web – why did you go, what were you doing? How much was that a conversation?

Caroline Jarrett’s model of forms – appearance (looks), conversation – jam in the middle of the sandwich (how it talks with the user), relationship (does it set up trust, credibility?)
We’ve been writing these for a while… UI, Error message – dialog boxes are conversation

The conversation is often prefaced with “How do I?”

Think of conversation as turn taking – it’s not always explicit, but you’re anticipating questions – implied conversation. Example – “What’s in the box?” – Hardware includes a SIM card (implied next question, “What’s a SIM card?” placed in a textbox) Last question after listing all the contents of the box, “Missing something?”

Another example – bulleted list “If you want to do this, here’s how” It’s a conversational way to do things, and there’s research to show it. Doesn’t have to be questions, can be “If/Then.”

Not this – Issuance of a TOP command results in a line zero condition.
This! To go to the beinning of your file, type TOP and press Enter.

Linguistics research on pragmatics (language in use, the context) The context may cause the utterance to have a meaning. Speech act theory – in many cases the spoken words are not taken literally, but you must understand the meaning behind the words.

4 maxims of conversation from Wikipedia – Gricean_maxims
If these are violated, cooperation/agreement declines.
Deborah Tannen – sociolinguist, misunderstandings because of the meta message behind the message – cultural, gender understandings.

Do not make your contribution more informative than is required – minimalist principles.

Person 1 – I’m low on gas.
Person 2 – There’s a station around the corner.
Assumptions – they’re in a car, that it’s a car fuel that they’re talking about
What if Person one responds, I know that, but I left my wallet at home – repairing the conversation. In writing, we have to anticipate the conversation so well that we think about how the conversation is interpreted and the user’s next question and response.
Person 2 has reason to believe that the gas station is open and is selling gas.

Next conversation – a good one or not? NO
To exit the program, type Quit and press Enter.
Be sure to save your files before you do that.
Actual example from a manual that Ginny has reviewed.

Implications of following Grice’s maxims:
know your users, what they know, and their context
think about interpretation (write so as not to be misunderstood)
realize that context changes
turn taking – give and take turns

Examples from Caroline Jarret, open university web forms
points – what are points, do you need them to graduate or to enter the program?

Pat Sullivan, Purdue University – dissertation from Carnegie Mellon, read only as far as what they thought would solve the problem.

Write with first things first – context first.
Approved fumigation with methyl bromide at normal atmospheric pressure in accordance with the following procedure, upon arrival at the port of entry, is hereby prescribed as a condition of importation for shipments of yams from foreign countries. (paraphrased)

Give and take in conversation
are pieces of info right sized for what user wants a s a chunk – too much (fire hose, wall of words), too little at a time (have to click Next too often)
are questions grouped logically

LiveValidation example:
Say “hello” to LiveValidation (form box)
if you don’t type fast enough, webform responds “How come you’ve not said ‘hello’ yet?”

CHI to HHI? Should it be not computer-human interaction but human-human interaction through the computer?
Tee hee, right when Ginny asked, are information products going away? Her slide show went on screen save mode.

More people go to Google than the user manual – should you spend resources contributing to the customer forum instead of expecting users to go to the manual?

Future of information for students – ? textbooks replaced by spectrum of web pages

Think “conversation.”
write conversations.
Facilitate conversations.

Related

Filed Under: social media, techpubs, writing Tagged With: conversation, social media, stc2008, techpubs, writing

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in