Manual of Style (MoS or MOS) is the style manual for all official Project Lazarus Wiki pages. This should be read before making edits to an official page.
The MoS summarizes the writing style of the Project Lazarus Wiki official pages so that the community volunteer editors can write and maintain the precise and consistent language, layout, and formatting when revising and updating pages. Much of this is lifted from the Phantom Forces Wikia Manual of Style.
This serves to ensure that all pages in the Wiki have a standardized writing style and formating.
Note that the Project Lazarus Wiki MoS only covers official pages that detail the mechanics and features in the Project Lazarus game. Community pages under the Community Guides category are not necessarily required to comply with the Wiki Manual of Style. However, it is still encouraged that the MoS be followed on all Wiki pages.
General Writing Style
As a general rule of thumb, the Wiki should maintain a professional and informative tone. The Wiki should provide information in an unbiased manner and avoid presenting unprovable opinions as fact.
- The Project Lazarus Wiki is written in American English.
- For example, the MoS hopes to achieve standardization and not "standardisation".
- Ensure that proper grammar and spelling.
- A common mistake is the incorrect use of the word "its" and the contraction "it's".
- It may prove useful to use in-browser spell-checking software such as Grammarly or to draft your edits in Microsoft Word.
Formality and Objectivity
To maintain professionalism, articles should be written in a formal tone and maintain objectivity.
- Write in the third-person perspective.
- When referring to the reader, refer to them as either the "player". The "user" is also acceptable.
- Do not write in the first or second point of view.
- For example, do not use "you", "I", "we", "our", etc.
- First-person is not objective - it is subjective and prone to opinions.
- Second-person is considered informal - as if the editor is having a casual conversation directly with the reader.
- Do not use contraction words.
- For example, do not use "don't", "can't", and "haven't".
- Expand the contractions and use "do not", "can not", and "have not" instead.
- Contraction words are colloquiums and have no place in formal writing.
- This is not to be confused with words with a possessive apostrophe.
- For example, the "weapon's recoil" is fine.
- For example, do not use "don't", "can't", and "haven't".
- Refrain from using definite words and numbers when discussing less objective statements.
- For example, it is fine to state "the weapon maintains its one-shot kill potential until round 18" because it is statistically true and verifiable.
- However, do not simply state "the weapon should be swapped out by round 18."
- A better phrasing would be "the weapon loses much of its viability upon round 18, where it loses its one-shot kill potential."
- If you are making a less objective statement, it should ideally be backed up with empirical reasonings.
- Never use subjective statements and words.
- For example, never call a weapon "the best gun in the game" or "the most awesome weapon". These statements are subjective and opinionated.
- While some weapons might be more powerful than others, e.g. a starting area wall weapon compared to a mystery box LMG, discussions like which is the best weapon becomes up for debate. One player may like the Ray Gun, but others prefer LMGs while some think the HK416 and assault rifles are superior for their mobility.
- There is no definite weapon in-game that has no flaws. Each individual has their own opinion, preferences and etc. As such, these subjective statements should be avoided.
- However, it is acceptable to state a weapon has the "best magazine capacity in-class" since this is an objective fact - the word "best" is not an issue here.
- For example, never call a weapon "the best gun in the game" or "the most awesome weapon". These statements are subjective and opinionated.
- Avoid colloquial words and informal phrases.
- There is a judgment call required here. However, avoid phrasing such as "trash damage" and use words like "poor damage" or even "abysmal damage" instead.
- Colloquialisms are inherently informal due to their conversational nature.
Inferring
Don't treat the reader as if they don't know anything. Instead, treat the user as if they have at least a basic knowledge of the subject matter. Assume they can perform basic research about the article. More importantly, don't restate the obvious. Restating the obvious reduces the quality of writing while simultaneously patronizing the reader.
Specific Clarifications
Use of Links
- Links to things like weapon category pages should be applied only to the first mention of that category in an article. Do not link every mention of that type of weapon in the article, as this clutters the page and is unnecessary.
- For example, on a page about an Assault Rifle, link the phrase "Assault Rifle" in the introductory sentence to the Assault Rifle category page. Any other mention of the phrase Assault Rifle should not be linked to that page.
Use of Pronouns
- Pronoun usage should be kept limited. For example, limit the number of times you referred to a weapon as 'it'. Instead, it is better to refer to the weapon by name, though not to the point of extremity.
- Think about how long it has been since the item in question was referred to by name. It is easy to get lost if there is any question about what "it" refers to. Proofread it - if you lose track of what "it" refers to, replace an "it" with a direct usage of the noun.
- Never use a pronoun in an introductory sentence.
- Use third-person and gender-neutral pronouns.
- For example, the "Player starts with a Beretta M9. They can buy additional weapons off walls."
- We do not know the gender of the player or the reader.
- Do not use words such as 'he' or 'she' except in the History or Trivia section of an article when referring to a person.
- For example, the "Player starts with a Beretta M9. They can buy additional weapons off walls."
Abbreviations
- There are various accepted abbreviations that can be used, e.g. "SMG" and "LMG".
- However, the full name is preferred. The abbreviation can only be used once the full phrase has been written out at least once.
- For example, "Submachine guns shoot fast. ... SMGs also have high recoil."
- Avoid technical abbreviations as they put an unnecessary burden on unfamiliar readers.
- For example, "aim down sights" instead of "ADS" and "rate of fire" instead of "RoF".
- Do not use informal abbreviations.
- Do not use "mag" for magazine.
- Use of "ammo" for ammunition should be limited and only used after the full word has been used.
- Abbreviations should be limited to use within their own technical pages.
- For example, you can use "ADS" under a page about the "Aim Down Sights" mechanic.
Capitalization
- Capitalize all proper nouns as per English grammar.
- For example, the names of historical figures.
- All weapon names should be capitalized. Use in-game capitalization for reference.
- For example, it is "AN-94 Abakan" and not "An-94 Abakan" or "AN-94 ABAKAN".
- Weapon classes are not capitalized. It should be written as "assault rifle" and not "Assault Rifle".
- Named utilities and perks in-game should be capitalized.
- For example, "Mystery Box" and "Speed Cola".
- Unnamed utilities and terms such as "wall weapon" should not be capitalized.
- Game mechanics and terms are not capitalized.
- For example, "points", "rounds", "knife", "zombies", "health", etc.