Plain English - Organise: Difference between revisions

no edit summary
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 23: Line 23:
The logical structure of a legal document is important — like computer code it should be clearly numbered and signposted. The discipline of paying attention to the logical structure helps you to write simply and elegantly. It forces you to organise yourself. it helps a reader navigate, which reduces review time. These are all commercial priorities. Therefore:
The logical structure of a legal document is important — like computer code it should be clearly numbered and signposted. The discipline of paying attention to the logical structure helps you to write simply and elegantly. It forces you to organise yourself. it helps a reader navigate, which reduces review time. These are all commercial priorities. Therefore:
*'''Multilevel list''': Number ''every'' sub-paragraph using a coherent multilevel list structure (for how, see “formatting” below). There should be no floating paragraphs without a number. This means you will need to structure your sentences so their logic only branches at the end. Have an elegant and intuitive numbering scheme, using digits, letters and romans, upper case and lower case (but not bullets: there must be a logical sequence to the numbers). Having a paragraph level “4.3.4.1.2” is ''not'' elegant or intuitive. We prefer:  
*'''Multilevel list''': Number ''every'' sub-paragraph using a coherent multilevel list structure (for how, see “formatting” below). There should be no floating paragraphs without a number. This means you will need to structure your sentences so their logic only branches at the end. Have an elegant and intuitive numbering scheme, using digits, letters and romans, upper case and lower case (but not bullets: there must be a logical sequence to the numbers). Having a paragraph level “4.3.4.1.2” is ''not'' elegant or intuitive. We prefer:  
{{quote|
{{subtable|
1 '''Title''' <br>
'''{{font|Helvetica}}1 LEVEL 1</span>'''
1.1 Sub-clause level 1
 
:(a) Sub-clause level 2
1.1 '''Level 2''': Lorem ipsum
::(i) Sub-clause level 3
:(a) '''Level 3''': Lorem ipsum
:::(A) Sub-clause level 4
::(i) '''Level 4''': Lorem ipsum
::::(I) Sub-clause level 5
:::(A) '''Level 5''': Lorem ipsum
:::::(1) Sub-clause level 6}}
::::(I) '''Level 6''': Lorem ipsum
*'''Optimise the number of levels''': Unless you are writing a monster document, you should not need to get anywhere near 7 sub-clause levels. If you do, this is a fair sign your logic is over-engineered. Don’t just collapse sub-paragraphs to reduce the number of sub-levels: rewrite the logic of the paragraph so you don’t need so many sub-levels.<ref>See: [[Semantic structure]].
:::::(1) '''Level 7''': Lorem ipsum}}
*'''Indent''': Always use “nested” indents — like modern computer code — as it effortlessly reveals structure, creates white space and allows, er, room for manuscript markup.  
*'''Optimise the number of levels''': Unless you are writing a monster document, you should not need to get anywhere near 7 sub-clause levels. If you do, this is a fair sign your logic is over-engineered. Don’t just collapse sub-paragraphs to reduce the number of sub-levels: rewrite the logic of the paragraph so you don’t need so many sub-levels.<ref>See: [[Semantic structure]].</ref>
*'''[[Fingerpost|Fingerposts]]: Include descriptive headings and a brief “fingerpost” for each sub-clause: the clearer the organisational layout is the better.
*'''Indent''': Always use “nested” indents — like modern computer code — as it effortlessly reveals structure, creates white space and allows, er, room for [[Mark-up|manuscript markup]].  
*'''[[Fingerpost|Fingerposts]]''': Include descriptive headings and a brief “fingerpost” for each sub-clause: the clearer the organisational layout is the better.
=== Formatting ===
=== Formatting ===
'''Microsoft Word''': Learn how to use paragraph-formatting, character-formatting, multilevel lists, auto-numbering and style formatting in MS Word. It is hard, somewhat counter-intuitive, but if you learn it, it makes formatting and organising paragraphs so much easier.
'''Microsoft Word''': Learn how to use paragraph-formatting, character-formatting, multilevel lists, auto-numbering and style formatting in MS Word. It is hard, somewhat counter-intuitive, but if you learn it, it makes formatting and organising paragraphs so much easier.