Combat Rules Writing Style Guide: Difference between revisions

From SCA Lochac
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Acronyms==
==Acronyms==
Avoid acronyms in the rules, they are a barrier to understanding.  The SCA is a well-established concept so can be used, including as SCA Inc, SCA Ltd and SCANZ
Avoid acronyms in the rules, they get in the way of understanding.  The SCA is a well-established concept so can be used, including as SCA Inc, SCA Ltd and SCANZ
*MIC = Marshal-in-Charge
*MIC = Marshal-in-Charge
*RMIC = Rapier Marshal-in-Charge
*RMIC = Rapier Marshal-in-Charge
*RMIT = Rapier Marshal-in-Training
*EqMIC = Equestrian Marshal-in-Charge
*EqMIC = Equestrian Marshal-in-Charge
*KEM = Kingdom Earl Marshal (or just Earl Marshal), not Kingdom Equestrian Marshal
*KEM = Kingdom Earl Marshal (or just Earl Marshal), not Kingdom Equestrian Marshal
Line 17: Line 16:
*Kingdom Armoured Combat Marshal is shorter than Deputy Earl Marshal for Armoured Combat
*Kingdom Armoured Combat Marshal is shorter than Deputy Earl Marshal for Armoured Combat
*Kingdom Earl Marshal
*Kingdom Earl Marshal
*Society Marshal - not Society Earl Marshal.  Marshal of the Society is also used.
*Society Marshal - not Society Earl Marshal.


==Avoid gendered language==
==Avoid gendered language==
Line 28: Line 27:


==Fractions and decimals==
==Fractions and decimals==
*Use fractions when using inches (the decimal numbers get weird)
*Put the metric number first (some people don't do Imperial anymore)
*Use decimals for metric units. Include the leading 0 in numbers like 0.75, not .75
*Use decimals for metric units. Include the leading 0 in numbers like 0.75, not .75
*use plain text - don't use special characters as it breaks the pdf generation
*Use fractions when using inches (the decimal numbers get weird).
*Use plain text - don't use special characters as it breaks the pdf generation, just a plain old 1/2.


==Plain English==
==Plain English==
Line 130: Line 130:
Refer to [https://www.rfc-wiki.org/wiki/RFC2119 RFC2119]
Refer to [https://www.rfc-wiki.org/wiki/RFC2119 RFC2119]


Use "must/must not" when it's compulsory, and there are no situations where there is an option to do otherwise.
Use "must/must not" when it's compulsory, and there are no situations where there is an option to do otherwise. Don't use "shall".


Use "should/should not" when it's the preferred option, but there are times/reasons that you might not.
Use "should/should not" when it's the preferred option, but there are times/reasons that you might not.

Latest revision as of 03:18, 5 April 2024

Acronyms

Avoid acronyms in the rules, they get in the way of understanding. The SCA is a well-established concept so can be used, including as SCA Inc, SCA Ltd and SCANZ

  • MIC = Marshal-in-Charge
  • RMIC = Rapier Marshal-in-Charge
  • EqMIC = Equestrian Marshal-in-Charge
  • KEM = Kingdom Earl Marshal (or just Earl Marshal), not Kingdom Equestrian Marshal
  • KRM = Kingdom Fencing Marshal
  • KEO = Kingdom Equestrian Officer
  • SRM = Deputy Society Marshal for Rapier
  • SEO = Society Equestrian Officer (Deputy Society Marshal for Equestrian)

Roles and job titles

  • rostered marshal - when someone needs to be an authorised marshal who is a current member (not an auxiliary marshal)
  • marshal - when any level of marshal will do - eg assistant marshal
  • Marshal-in-Charge - person responsible for a combat event - eg a practice, or a tournament, or pick up field
  • Kingdom Armoured Combat Marshal is shorter than Deputy Earl Marshal for Armoured Combat
  • Kingdom Earl Marshal
  • Society Marshal - not Society Earl Marshal.

Avoid gendered language

We are a Society of very diverse people, so should avoid using gendered terms. Use the singular they.

  • his or her = their
  • he or she = they
  • himself or herself = themself (use themselves for more than one person)
  • him or her = them
  • My Lord/My Lady, you are slain = Fighter, you are slain

Fractions and decimals

  • Put the metric number first (some people don't do Imperial anymore)
  • Use decimals for metric units. Include the leading 0 in numbers like 0.75, not .75
  • Use fractions when using inches (the decimal numbers get weird).
  • Use plain text - don't use special characters as it breaks the pdf generation, just a plain old 1/2.

Plain English

"Explain it like I'm 5." These rules should not need a university level of reading comprehension, they aren't legal documents, so don't write them in legalese. To make your content easy to understand, use plain English:

  • Use clear and straightforward language.
  • You can still use technical terms, you just need to explain them.
  • Use the active voice, not the passive voice. You can tell you are using passive voice if you can add "by zombies" and it still makes grammatical sense.
    • Passive: The form was processed and returned (by zombies).
    • Active: We completed your request and mailed the form to you.
  • Use positive language wherever possible.
  • Be direct and concise.
  • Begin instructional headings with an active imperative verb.
  • Don't "undertake" anything.... "Undertake inspection of armour" - how about you just inspect armour!

Use these simple words to help make your content clear and easy to understand:

Use… Not…
about regarding
in regard to
in respect of
relating to
with reference to
after following on
subsequent to
agree are in agreement
ask enquire
because of as a consequence of
before prior to
by or from on the basis of
by or under in accordance with
pursuant
changed or move transition
developing the development of
done undertaken
end or stop discontinue
terminate
except for with the exception of
for on behalf of
help assistance
facilitate
is constitutes
more further
most the majority of
question enquiry
so accordingly
start or begin commence
taking into account with due regard to
to in order to
try attempt
use usage
utilise
employ

Must/Should/May

Refer to RFC2119

Use "must/must not" when it's compulsory, and there are no situations where there is an option to do otherwise. Don't use "shall".

Use "should/should not" when it's the preferred option, but there are times/reasons that you might not.

Use "may" when it's optional - preferably use "are allowed to...". Avoid using "may not", use "are not allowed to...".

Hyphenation

Hyphenate when two words need to be taken together to describe (modify) another word (noun). Hyphenate words that have to be taken together to make sense.

Hyphenate examples Don’t hyphenate examples
These tasks need your sign-off. The marshal will sign off the paperwork.
Callum is the Marshal-in-Charge of the tourney Find out who is the marshal in charge of this bout.
easy-to-read document The document is easy to read.
re-sign (sign again) resign (give up)
this is the up-to-date version of the rules The rules are up to date.