N1GP:Style guide: Difference between revisions

From N1GPedia
No edit summary
No edit summary
Line 2: Line 2:


The '''style guide''' is a set of guidelines for writing articles in the N1GP wiki.
The '''style guide''' is a set of guidelines for writing articles in the N1GP wiki.
[[File:StyleGuideHeader.png]]


This is not intended to be prescriptive and violating it where it makes sense is encouraged. However, in order for content to be easily found and digested by readers,  
This is not intended to be prescriptive and violating it where it makes sense is encouraged. However, in order for content to be easily found and digested by readers,  

Revision as of 20:28, 26 October 2022

THIS IS A DRAFT! DON'T TAKE THIS TO BE ANYTHING AUTHORITATIVE (YET)

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 content to be easily found and digested by readers,

Naming

Articles should be named 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, they should be named by the full name of the chip or part. For instance:

  • ❌ BassAnly
  • ❌ BassAnomaly
  • ✅ Bass Anomaly

If a concept exists across multiple games, the name of the article should be proceeded by the game abbreviation in parentheses, e.g. an article for Bass Anomaly for Battle Network 6 should be named 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, Corn Shot 1/2/3 should be grouped into the CornShot chip series, and Attack +1 and Attack MAX should be grouped 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.