Documentation Style Guide
Rules of Thumb
- Use simplistic and easily understandable language over complex and obscure language wherever possible. This is to ensure that the SEI is as accessible to the general public as possible.
- Do not make absolute or black/white assertions. For example "XYZ can creating the feeling that" over "XYZ will create the feeling that"
- Do not talk about the conclusions reached during these states as if they are inherently true, instead make it clear that you are simply describing the experience of them.
Write about facts, note speculation:
- Find a balance between (a) acknowledging when content is subjective or speculative, and (b) using a direct and confident writing style.
- Do not make absolute or black/white assertions. For example "XYZ can creating the feeling that" over "XYZ will create the feeling that"
- Do not talk about the conclusions reached during these states as if they are inherently true, instead make it clear that you are simply describing the experience of them.
Levels of intensity intro
"This effect is capable of manifesting itself across the x different levels of intensity described below:"
Tiers
- At the lowest level, …
- At this level, …
- At the highest level, …
Referring to the experiencer
- “A person” is preferred
- "At this level a person experiences morphing"
- “One’s” is secondary and provides variety
- “At this level one’s vision is completely encompassed by geometry”
Outro paragraph sentence:
"Effect is most commonly induced under the influence of low/moderate/heavy dosages of hallucinogenic compounds, such as type list. However, it can also occur under the influence of type list, particularly during phase [or as a result of x]"
Word preferences:
- To describe a given environment in its entirety: Scene
- To describe the surface of a given object (like the surface of a wall in a video game): Texture
- To describe a given object: Object
- To describe the experience of an effect of an illusion: Perception
- To describe increasing intensity across multiple tiers: Progressive
- To describe common sober experiences (to contrast with intoxicated effects): Everyday (life)
- To describe an illusion the subject recognizes to be false: Hallucination / hallucinatory
- To describe an illusion the subject cannot recognize as such: Delusion
- To describe the lower bound of an effect range: Subtle
- To describe the upper bound of an effect range: Extreme
Grammatical/syntax preferences:
- To refer to all possible trips: use "a trip" or "a [substance] trip" is preferred when referring to a trip. This makes the language general and inclusive, so it is clear that a specific trip or kind of trip is not being denoted. Example: "The first stage of a DMT trip is the onset"
- To refer to specific trips: use "the trip": use "the trip" or "the [substance] trip" when referring to a specific trip in narrative, or when a kind of experience given specific parameters is being discussed. Example: "After describing the LSD trip Hofmann had experienced, the lecture hall giggled."
- Use of and/or: Do not use "and/or", it can always be replaced with more specific language that is more readable.