Re: what doc formats do READERs want ?

Subject: Re: what doc formats do READERs want ?
From: Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 14 Dec 2011 06:36:51 -0800 (PST)

Since you're accepting anecdotes, I'll chime in with two of mine...  I think the answer is, "It depends".  The format readers want depends on the type and  purpose of the information.  For API docs that can (should) integrate in an IDE, the answer is definitely HTML.  And actually, I have found that to be true for API docs in all circumstances.  But nobody sits down to read API docs from cover to cover.  At least, I've never seen it (anecdote #1).  I extend that to say, if the information is reference, and benefits from random access, search, and other munging techniques, HTML is the way to go.

For me, if it's to be read cover to cover, I prefer paper.  I spend too much time in front of a machine already.  To be honest, I have a page limit for PDF, and it's even shorter than my limit for HTML.  In fact, the only PDF I actually *choose* to read is sheet music.  Otherwise, I tend to read it only because it's there.  Well, that's also true for sheet music.  The only reason I read PDF is because it's easier to get than paper.  Were it equally accessible in print, I would prefer that (anecdote #2). 

Bottom line, text is a purpose-driven technology.  Typography and legibility are functions of that purpose.  So I think the answer to your question really is, "It depends".  Depending on which sector you investigate, you will get different answers.  Or, depending on which sector ultimately dominates text.

Maybe that's really the question you're asking -- Which sector is dominating text?

cud
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Previous by Author: Re: How/where would you handle this documentation problem? (david hendler)
Next by Author: Re: the Hadoop comic
Previous by Thread: RE: what doc formats do READERs want ?
Next by Thread: Job offers and rates - what do you feel is acceptable?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads