| <COMMENT>
Title: Competetive Analysis Documentation Checklist
Author: Jack (KELLS::)Donohue, CUP/ML, MLO3-6/T76, DTN 223-1278
Abstract: This checklist was designed to systematize the collection of
information on documentation for competetive document editors.
It is coded in SDML and processed under the GENERAL doctype of VAX document.
<ENDCOMMENT>
<ALIGN_CHAR>(#)
<TABLE>( Competetive Documentation Analysis Checklist )
<TABLE_SETUP>(4\15\15\15\15)
<TABLE_ROW>(<SPAN>(2\LEFT)Book Title <RULE>\<SPAN>(2\LEFT)Pages /
% Pages with Graphics<RULE>)
<TABLE_ROW>(<SPAN>(2\LEFT) Software <RULE>\<SPAN>(2\LEFT)Vendor <RULE>)
<TABLE_ROW>(<EMPHASIS>(Overall Evaluation\BOLD))
<TABLE_ROW>(<SPAN>(1\LEFT)<BOX>(#)#Excellent <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Good <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Fair <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Poor <RULE>)
<TABLE_UNIT>
<TABLE_ROW>(<EMPHASIS>(FORMAT\BOLD)\)
<TABLE_ROW>(##<EMPHASIS>(Page Size\BOLD)\ <BOX>(#) 7" x 9" \<BOX>(#) 8 1/2" x
11" \<SPAN>(1\LEFT)<BOX>(#) Other <RULE>)
<TABLE_ROW>(##<EMPHASIS>(Chapters\BOLD) \ <BOX>(#) numbered \<BOX>(#) unnumbered)
<TABLE_ROW>(##<EMPHASIS>(Heads\BOLD) \ <BOX>(#) numbered \ <BOX>(#) unnumbered)
<TABLE_ROW>(##<EMPHASIS>(Sections\BOLD) \ <BOX>(#) numbered \ <BOX>(#)
unnumbered)
<TABLE_ROW>(##<EMPHASIS>(Margins\BOLD)\)
<TABLE_ROW>(####size\<BOX>(#) wide left\<BOX>(#) wide right\<BOX>(#) all
narrow (1"-))
<TABLE_ROW>(####contents\<BOX>(#) text\<BOX>(#) graphics)
<TABLE_ROW>(##<EMPHASIS>(Type\BOLD))
<TABLE_ROW>(####<BOX>(#) reference\<BOX>(#) alphabetic\<BOX>(#) logical
structure)
<TABLE_ROW>(####<BOX>(#) tutorial\<SPAN>(3\LEFT)<BOX>(#) "cookbook" (A
step-by-step sequence of actions to create an entire document.))
<TABLE_ROW>(\<SPAN>(3\LEFT)<BOX>(#) modular (A group of discrete
modular exercises that are used (semi-)independently))
<TABLE_ROW>(####<BOX>(#) mixed)
<TABLE_ROW>(##<EMPHASIS>(Layout\BOLD)\)
<TABLE_ROW>(####Text \ <BOX>(#) concise, small paragraph \
<BOX>(#) wordy, large paragraph \ <BOX>(#) mixed)
<TABLE_ROW>(####Graphics \<BOX>(#) scanned image (3-D) \ <BOX>(#) simulated 3-D \
<BOX>(#) 2-D (line art))
<TABLE_ROW>(####Graphic Positioning\<BOX>(#) arbitrary \ <BOX>(#) centered on
page \ <BOX>(#) aligned left/right )
<TABLE_ROW>(####Graphic Enhancement\<BOX>(#) captions \ <BOX>(#) borders \
<BOX>(#) callouts)
<TABLE_ROW>(####Text/Graphics \<SPAN>(3\LEFT)<BOX>(#) full (text flows
into/through graphics))
<TABLE_ROW>(######Integration \<SPAN>(3\LEFT)<BOX>(#) partial (text surrounds
graphics) )
<TABLE_ROW>(\<SPAN>(3\LEFT)<BOX>(#) none (text abuts graphics) )
<TABLE_ROW>(####Color Text Usage \ <BOX>(#) input/output \<BOX>(#) new terms \
<BOX>(#) notes)
<TABLE_ROW>(####Color Graphics Usage \ <BOX>(#) pointers \<BOX>(#) active areas\
<BOX>(#) screen images)
<TABLE_ROW>(####Tables \ <BOX>(#) tab tables \ <BOX>(#) true tables)
<ENDTABLE_UNIT>
<TABLE_ROW>(<SPAN>(4\LEFT)Comments<RULE>)
<TABLE_ROW>(<EMPHASIS>(Format Evaluation\BOLD))
<TABLE_ROW>(<SPAN>(1\LEFT)<BOX>(#)#Excellent <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Good <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Fair <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Poor <RULE>)
<TABLE_UNIT>
<TABLE_ROW>(<EMPHASIS>(CONTENT\BOLD)\)
<TABLE_ROW>(##<EMPHASIS>(Tone\BOLD)\<BOX>(#) informal (2nd person)
\<BOX>(#) formal (3rd person))
<TABLE_ROW>(##<EMPHASIS>(Audience\BOLD)\ <BOX>(#) Retail \ <BOX>(#) Technical \
<BOX>(#) mixed )
<TABLE_ROW>(##<EMPHASIS>(Organization\BOLD)\)
<TABLE_ROW>(####Medium \ <BOX>(#) online \ <BOX>(#) hardcopy\<BOX>(#) mixed )
<TABLE_ROW>(####Presentation \ <BOX>(#) interactive \ <BOX>(#) passive \
<BOX>(#) mixed)
<ENDTABLE_UNIT>
<TABLE_UNIT>
<TABLE_ROW>(##<EMPHASIS>(Referencing\BOLD))
<TABLE_ROW>(####Table of Contents)
<TABLE_ROW>(######topic head levels\<BOX>(#) unnumbered \ <BOX>(#) numbered)
<TABLE_ROW>(######tables \ <BOX>(#) numbered by chapter \<BOX>(#) numbered by
book )
<TABLE_ROW>(######graphics \<BOX>(#) numbered by chapter \ <BOX>(#) numbered
by book )
<TABLE_ROW>(####Index \<BOX>(#) multiple levels \<BOX>(#) cross-references
\<BOX>(#) continuation pages)
<TABLE_ROW>(####Glossary###<BOX>(#)\)
<TABLE_ROW>(####Footnotes##<BOX>(#)\ <BOX>(#) end of page \ <BOX>(#) end of
chapter/section \ <BOX>(#) end of book )
<TABLE_ROW>(####Help#######<BOX>(#) \<BOX>(#) online \<BOX>(#) context sensitive )
<TABLE_ROW>(####Other######<BOX>(#)\<SPAN>(1\LEFT)#<RULE>\\\)
<TABLE_ROW>(<SPAN>(4\LEFT)Comments<RULE>\)
<TABLE_ROW>(<EMPHASIS>(Content Evaluation\BOLD))
<TABLE_ROW>(<SPAN>(1\LEFT)<BOX>(#)#Excellent <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Good <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Fair <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Poor <RULE>)
<TABLE_ROW>()
<TABLE_ROW>(<EMPHASIS>(PACKAGING\BOLD))
<TABLE_ROW>( ##<EMPHASIS>(Paper Weight\BOLD)\<BOX>(#)#50\<BOX>(#)#60
\<SPAN>(1\LEFT)<BOX>(#) Other <RULE>)
<TABLE_ROW>(##<EMPHASIS>(Binder\BOLD))
<TABLE_ROW>(####Spine\<BOX>(#) 3-ring\<BOX>(#) wire-O\<BOX>(#) perfect)
<TABLE_ROW>(####Case\<BOX>(#) glossy\<BOX>(#) linen\<BOX>(#) vinyl)
<TABLE_ROW>(####Cover Color \<BOX>(#) full\<BOX>(#) 3-color\<BOX>(#) B & W)
<TABLE_ROW>(##<EMPHASIS>(Tabs\BOLD)<BOX>(#) )
<TABLE_ROW>(<SPAN>(4\LEFT)Comments<RULE>)
<TABLE_ROW>(<EMPHASIS>(Packaging Evaluation\BOLD))
<TABLE_ROW>(<SPAN>(1\LEFT)<BOX>(#)#Excellent <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Good <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Fair <RULE>
\<SPAN>(1\LEFT)<BOX>(#)#Poor <RULE>)
<ENDTABLE_UNIT>
<ENDTABLE>
<ENDALIGN_CHAR>
|
|
Nice example! Two minor points:
1) When I run the example using the REPORT doctype,
device LN03, the "Referencing" title clobbers the Table
title on the second page. I consider this a minor
DOCUMENT bug rather than an error in your example.
Work-around: putting a <TABLE_ROW>() -- a null row, that
is -- *between* the table_units (just before the one
beginning with "Referencing") solves the problem.
Alternatively, I suspect use of a <table_unit_heads> tag
would solve the problem.
2) Competitive should be spelled as it is in this
sentence.
A suggestion for those who prefer to avoid the "Table"
label on their output: instead of the formal
<TABLE>(title here)
format, make the table in informal one by beginning
with
<TABLE>
without a title or even parentheses. If you wish a
title, it can simply be a first row in the table itself,
formatted appropriately with <span>, <rule> and/or
<emphasis> as you desire.
|