N1GP:Style guide: Difference between revisions

From N1GPedia
Line 28: Line 28:
Always use the active voice where possible. This makes the subject clear and prominent, and avoids the potential for vagueness and complex prepositional phrases.
Always use the active voice where possible. This makes the subject clear and prominent, and avoids the potential for vagueness and complex prepositional phrases.


Examples:
'''Example:'''
* ❌ An enemy is hit by Cannon for 40 damage.
* ❌ An enemy is hit by Cannon for 40 damage.
* ✅ Cannon hits an enemy for 40 damage.
* ✅ Cannon hits an enemy for 40 damage.
Line 34: Line 34:
However, if it makes sense to keep the subject prominent through multiple sentences, it may be better to use the passive voice. For instance:
However, if it makes sense to keep the subject prominent through multiple sentences, it may be better to use the passive voice. For instance:


Examples:
'''Example:'''
* 🤷 Cannon hits an enemy for 40 damage. Attack +10 can boost it for 50 damage.
* 🤷 Cannon hits an enemy for 40 damage. Attack +10 can boost it for 50 damage.
* ✅ Cannon hits an enemy for 40 damage. It can be boosted with Attack +10 for 50 damage.
* ✅ Cannon hits an enemy for 40 damage. It can be boosted with Attack +10 for 50 damage.

Revision as of 01:00, 27 October 2022

The style guide is a set of guidelines for writing articles in the N1GP wiki.

StyleGuideHeader.png

This is not intended to be prescriptive and violating it where it makes sense is encouraged. However, in order for readers to easily find and digest content, the guidelines here should take precedence.

Also, if you don't like parts of this guide, edit it! (but let everyone know you're editing it)

Naming

You should name articles in sentence case, unless the title uses proper nouns. All chip, NaviCust part names, Souls, and Crosses are considered proper nouns.

For chips and NaviCust parts, you should name them by the full name of the chip or part. For instance:

  • ❌ BassAnly
  • ❌ BassAnomaly
  • ✅ Bass Anomaly

If a concept exists across multiple games, you should proceed the name with the game abbreviation in parentheses, e.g. you should name the article for Bass Anomaly for Battle Network 6 Bass Anomaly (BN6). For concepts that only exist in a single game, it is OK to omit the abbreviation, e.g. Tomahawk Cross.

For chips and NaviCust parts in the same family, we try to group them together to avoid duplicating content. For instance, you should group Corn Shot 1/2/3 into the Corn Shot chip series, and Attack +1 and Attack MAX into the Attack NaviCust part series.

Content

The first line of an article should contain a brief summary of the topic, along with bolded text containing the name of the article as the first phrase in the article, after any articles (e.g. The). For chips and NaviCust parts, they should describe the "obvious" effect of the chip or part.

Any following paragraphs should go into more detail about the topic. You should try to follow the "funnel" technique of writing: more general details should come first, followed by more specific or technical details.

Active vs. passive voice

Always use the active voice where possible. This makes the subject clear and prominent, and avoids the potential for vagueness and complex prepositional phrases.

Example:

  • ❌ An enemy is hit by Cannon for 40 damage.
  • ✅ Cannon hits an enemy for 40 damage.

However, if it makes sense to keep the subject prominent through multiple sentences, it may be better to use the passive voice. For instance:

Example:

  • 🤷 Cannon hits an enemy for 40 damage. Attack +10 can boost it for 50 damage.
  • ✅ Cannon hits an enemy for 40 damage. It can be boosted with Attack +10 for 50 damage.

Terminology

We want to strive to keep terminology used across the wiki consistent. If you see anything using one of the other terms, please change it to the standard term. If you notice that the same concept is being referred to by two different terms and isn't in the list below, please add it.

We should also prefer fully-written out names (e.g. "time freeze cancel" over TFC) so terms are self-explanatory in the context they appear in.

Standard term Other terms Description
drag Effect applied by Wind Racket's impact. Subtypes of drag include small pull, small push, big push. Not to be confused with slide.
flashing Invis, invisible, blinking (MMSF term) Effect applied Invisible/being hit by most chips.
frames i, f, ticks Technically ticks, but frames are an easier concept to understand.
invulnerable invincible, "green" Effect applied by Fanfare or Color Bug.
paralyzed (status effect) paralysis, paralyzation, stun Effect applied by White Capsule.
slide Effect applied by Wind or Fan gusts. Not to be confused with drag.
time freeze cancel cut in (official), TFC Occurs when a time-freezing chip is interrupted by a different time-freezing chip.
time-freezing dimming (official) Time freeze effect caused by e.g. Navi chips.
White Capsule whitepill based and whitepilled

Players, opponents, users, and enemies

  • Player: Refers to you, the person.
  • Opponent: Refers to not you, the other person.
  • User: Refers to the Navi using the chip.
  • Enemy: Refers to the entity being targeted by a chip.

Examples:

  • ❌ Cannon hits the opponent for 40 damage.
  • ✅ Cannon hits an enemy for 40 damage.
  • Why: Hitting the other person is assault.
  • ❌ Recovery 10 heals the player for 10 HP.
  • ✅ Recovery 10 heals the user for 10 HP.
  • Why: An enemy using Recovery 10 does not heal the player.
  • ❌ Area Grab steals a column of tiles from the enemy's side.
  • ✅ Area Grab steals a column of tiles from the opponent's side.
  • Why: Enemies do not always stand on the opponent's tiles.