Off topic - three general documentation questions

[John Sgammato]

Here are my thoughts based on my deliverables, my users' needs, and my
employer's expectations. Your responses may vary significantly based on
those and other variables.

*         Do not use chapter numbers/appendix letters

I use chapter numbers in my printed books and PDFs, but not in online
help. IMO they serve a valuable navigation function for the reader of a
printed doc, helping to keep his/her bearings in the mass of pages.

*         Begin main index entries with a capital letter

I would not, partly because an index entry is not a sentence and the
capitalization might imply a meaning that does not exist, but also
because it is much quicker to make an index entry by simply
double-clicking the term without having to edit it on the spot. Of
course, you still have to edit it if it starts a sentence or is
capitalized for any other reason, but that is not so often.  

*         Put a logo (or message) on blank pages to show that they are
not blank in error.

Because I print my books, I have all my chapters end on an even page,
even if it is blank. My header and footer appear on those otherwise
blank pages. The only time I get a question about it is when someone
reads the PDF and comes upon a blank page for no obvious reason.
Honestly, in 10 years with these templates the confusion has been
brought to my attention maybe 6 times.

Ymmv, etc, etc
john

-----Original Message-----
From: framers-bounces at lists.frameusers.com
[mailto:framers-bounces at lists.frameusers.com] On Behalf Of Saunders, Ian
Sent: Friday, March 13, 2009 5:45 AM
To: framers at lists.frameusers.com
Subject: Off topic - three general documentation questions

Please forgive this off-topic query, but I have nowhere else to turn for
help.

My team are reviewing the Frame templates we use for producing PDF
files. It has been suggested that we:

*         Do not use chapter numbers/appendix letters

*         Begin main index entries with a capital letter

*         Put a logo (or message) on blank pages to show that they are
not blank in error.

We have reached an impasse...

I would be extremely grateful to anyone who can supply their take on the
relevant "industry standards" or maybe even point me at a definitive
statement.

Many thanks!

Ian Saunders
Syntellect Inc

_______________________________________________


You are currently subscribed to Framers as jsgammato at imprivata.com.

Send list messages to framers at lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscribe at lists.frameusers.com
or visit
http://lists.frameusers.com/mailman/options/framers/jsgammato%40imprivat
a.com

Send administrative questions to listadmin at frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.