Pattern : (distinctive)
HEADINGS CONVEY STRUCTURES
- PROBLEM : How do you help the reader understand how the
individual patterns he/she is reading fits within the overall
structure of the language?
- CONTEXT : You are writing a pattern language that has a
non-trivial structure. You are applying Visible Language Structure
because you recognize that it is important for the reader to be able
to understand how the individual patterns he/she is reading fits
within the overall structure of the language. You are attempting to
make the resulting language Single-Pass Readable
- FORCES :
- In pattern
languages with complex structure, readers may find it
easier to appreciate the individual patterns if they
understand how they fit within the structure of the
language.
- When reading
through a complex pattern language for the first time,
it is easy to lose track of where you are within the
structure of the language.
- A lengthy "you are
here" section for each pattern is repetitive, adds
unnecessary bulk to the language, and may distract the
reader from the patterns themselves.
- An introductory
section, at the beginning of the pattern language, can
be an effective means to communicate the overall
structure of the language.
- A language takes
longer to read (and is not Single-Pass Readable) if the
readers need to constantly refer back to the
introductory section to figure out where they are.
- SOLUTION :Make individual pattern headings visibly different from all other document section headings. Prefix pattern headings with
hierarchical section numbers, where the section numbering hierarchy parallels the language structure.
- RATIONALE : The reader can easily recognize pattern sections and can tell at a glance how the given pattern fits within the
language structure. Section numbers are concise, and do not distract the reader from the patterns themselves. Major changes in section
numbers can signal the reader that he/she has come to a new section of the pattern language.
