Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 1 Jul 1996 16:51:55 -0400 (EDT)
From:      Tim Vanderhoek <hoek@freenet.hamilton.on.ca>
To:        "Julian H. Stacey" <jhs@FreeBSD.ORG>
Cc:        doc@FreeBSD.ORG
Subject:   Re: share/doc/FAQ/obj/freebsd-faq.html
Message-ID:  <Pine.SOL.3.91.960701163727.22909A-100000@james.freenet.hamilton.on.ca>
In-Reply-To: <199607011633.SAA13589@vector.jhs.no_domain>

next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, 1 Jul 1996, Julian H. Stacey wrote:

> Style & Colloquialisms:

...

> 	  	 7.6. Printer too slow: how to speed it up./
> 	Colloquial `slow as a dog'  is fine for native English speakers,
> 	but is it obvious to a Chinese or Brazilian etc ?

I think only as many colloquialisms as are necessary to make it readable 
for non-english readers should be removed.  In some instances it may be 
possible to make the meaning clear while maintaining the nice expressions.


> Daft answers don't deserve to clutter the index & waste space forever:
> 	Delete:
> 		`7.20. Has anyone done any temperature testing.....'
> 	the question is debatable, the answer is just wasted space.
> 	Delete `7.21 ...memory to make a scratchy sound?...'
> 		The answer is wasted space, & doesnt even mention
> 		the floppy media sensing head seeks in the bios.

Bah!  Go away!  Those are nice questions!  However, they do clutter it up 
terribly.  I think the proper solution is to reorganize the index to the 
questions.  Some things, such as the questions regarding the ATI Mach64 & 
sio3 confict do _NOT_ need to take up half-a-page just to INDEX the question.
I think perhaps some sort of "question hierarchy" with no more than 10 
selections in each section would make a better index than the current 
(dare-I-call-it) mumbo-jumbo.


> 	Reorder the words in the FAQ sections titles,
> 	similar to the way a stores list of engineering components is listed,
> 	so that the index is visually scannable fast & easily.  EG:
> 		Printer, colour, driver: fails when blah blah
> 		Printer, postscript: filters available
> 		Printer, parallel port: interrupt config
> 		Printer, serial: interface parameters

Such a technical approach to it scares me.  Rather, I would have a 
section `hardware problems'.  `Hardware Problems' would then link to a 
subsection listing another 4-10 subsubsections.  One of those would be 
`Printer Problems'.  

Basically, just going from a list of general categories to a list of more 
specific categories, and eventually to a list of actual questions.  Each 
list limited to 4-10 entries.


> Changes would require some small departure from the traditional net news FAQ
> format, but that was typically just a collection of Q & A's slung together
> by one person. 

There are the leaders and the followers!  :)


> This is intended as constructive criticism,  hoping not to annoy anyone,
> Yes, I too find the FAQ useful even as is, Thanks :-)

I look at the INDEX for the FAQ, and I'm scared...  It's ugly... :(


--
Outnumbered?  Maybe.  Outspoken?  Never!
tIM...HOEk




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?Pine.SOL.3.91.960701163727.22909A-100000>