Re: How many levels of indents and heads are reasonable?

Subject: Re: How many levels of indents and heads are reasonable?
From: "Raj Machhan" <raj -dot- machhan -at- gmail -dot- com>
To: "Ned Bedinger" <doc -at- edwordsmith -dot- com>
Date: Mon, 15 Oct 2007 22:11:14 -0700

Yeah Ned. Point taken.

On 10/15/07, Ned Bedinger <doc -at- edwordsmith -dot- com> wrote:
>
> Raj Machhan wrote:
> > Agreed. The technical document has to be correct in all aspects. But
> isn't
> > it understood? Can this ever be a debatable point? Wasn't this the first
> > thing that is told to each and every writer.
>
> No, the usual first (and last, and in between) thing is always stylistic.
>
> If one needs to talk about being
> > correct in a forum like ours, I guess we are undermining the
> intellectual
> > ability of the members.
>
> Honestly, I'd have to say it depends. In some cases, I'm sure it is
> taken for granted and that's why we don't discuss it.
>
> Unfortunately, the worst tech writing problems I've ever seen are the
> ones that come from technical writers who are not able to get projects
> right. Sometimes it is due to schedules, sometimes due to bad matches
> between project and writer, and SOMETIMES it is due to tech writers who
> put form over function, skipping rightness in order to pursue
> refinements of grammar and punctuation, style guides, tools, and the
> making of pretty readable documents. I say that's all well and good for
> tech writing (we operate in a cloud of skills and expertise), but it is
> only half of the enchilda--we also need the rightness part.
>
> Debating the goodness of this problem is a fool's errand, but discussion
> of it isn't so bad, is it?
>
> Ned Bedinger
> doc -at- edwordsmith -dot- com
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.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-unsubscribe -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.techwr-l.com/ for more resources and info.


Follow-Ups:

References:
How many levels of indents and heads are reasonable?: From: Van Laan, Krista
RE: How many levels of indents and heads are reasonable?: From: Butler, Darren J Ctr 584 CBSS/GBHAC
Re: How many levels of indents and heads are reasonable?: From: Ned Bedinger
Re: How many levels of indents and heads are reasonable?: From: Raj Machhan
Re: How many levels of indents and heads are reasonable?: From: Ned Bedinger
Re: How many levels of indents and heads are reasonable?: From: Raj Machhan
Re: How many levels of indents and heads are reasonable?: From: Ned Bedinger

Previous by Author: Re: How many levels of indents and heads are reasonable?
Next by Author: Re: Unique Documentation
Previous by Thread: Re: How many levels of indents and heads are reasonable?
Next by Thread: Documentation Correctness was Re: How many levels of indents and heads are reasonable?


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


Sponsored Ads