Skip to content

Commit 9fc93c6

Browse files
authored
Document Writing Style for Headings and Bullet Point Lists
1 parent e882262 commit 9fc93c6

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.adoc

+25
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,31 @@ git clone https://github.com/isaqb-org/curriculum-t3.git --recursive
4646
. Build the project with http://www.gradle.com[gradle] (you need a locally installed JDK) via `./gradlew`.
4747
. Once the "BUILD SUCCESSFUL" is shown, you can review the build result under `./build/index.html`
4848

49+
== On writing style
50+
51+
To keep writing style consistent accross multiple iSAQB documents, please apply the styles used in the Foundation Level Curriculum.
52+
53+
=== Heading Capitalization
54+
55+
Use title case for all headings:
56+
57+
* capitalize: first and last word, nouns, pronouns, adjectives, verbs
58+
* lowercase: articles and prepositions
59+
60+
When in doubt, opt for https://capitalizemytitle.com/style/Chicago/[Chicago Style].
61+
62+
=== Bullet Point Lists
63+
64+
To unify upper/lowercase within the (EN) version, we use the _Chicago manual of style proposal_":
65+
66+
* short bullet items don't get a full-stop
67+
* next one starts lowercase
68+
* if bullets are phrases or fragments, dont use punctuation
69+
* if and only if an item is a really long sentence which deserves a full stop, or consists of several sentences, then we use it.
70+
* Only then does an item start with uppercase.
71+
72+
For a possible German (DE) version, don't use punctuation at the end of bullet-list items, unless on ends-of-sentences.
73+
4974

5075
== Maintainers
5176

0 commit comments

Comments
 (0)