View source for Vault Hunters Official Wiki:Style guide

= Vault Hunters Official Wiki: Style Guide =

== Article Titles ==

* Titles should be written in singular form, except for in-game features that explicitly use plural names
** '''Singular Example:''' [[Vault Axe]]
** '''Plural Example:''' [[Vault Boots]]
* Don't include the word "Vault" unless it's explicitly used in the name of the item in-game
** '''Example:''' "Vault Sword" is fine because the in-game item is "Vault Sword". "Vault Decks" isn't the name of the item in game, so the page would be called "Decks" (or "Deck" to follow the first guideline as well)
* Disambiguation suffixes should be in lower case and surrounded by parenthesis <code>( )</code>
** '''Example:''' [[Focus (gear)]] instead of Focus (Gear)
* Each page should be about a single subject
** '''Example:''' Separate pages for "Horses" and "Camels" instead of one page called "Horses and Camels"

== Article Content ==

=== General Writing Guidelines ===

'''Tone and Voice:'''
* Write in an encyclopedic style with a slight gaming community feel
* Use third person perspective ("the player" rather than "you")
* Be informative and precise while remaining accessible
* Avoid overly casual language or slang, but don't be unnecessarily formal
* '''Good:''' "This mechanic allows players to enhance their vault runs"
* '''Avoid:''' "This totally lets you beef up your vaults" or "This mechanism facilitates the augmentation of vault expeditions"

'''Tense and Perspective:'''
* Use present tense for describing game mechanics and features
* Use past tense only when describing removed features or historical information
* Maintain neutral point of view - present facts, not opinions

'''Capitalization:'''
* Follow in-game capitalization for item names, mechanics, and proper nouns
* Use sentence case for section headings
* Capitalize "Vault Hunters" when referring to the modpack

=== Page Structure and Organization ===

'''Standard Page Layout:'''
# '''Introduction paragraph''' - Brief description of the subject
# '''Infobox''' (when applicable using appropriate templates)
# '''Main content sections''' organized logically
# '''Gallery section''' (if multiple images)
# '''History/Changes section''' (for version-specific information)
# '''References section''' (when needed)

'''Section Headings:'''
* Use descriptive, consistent heading names
* '''Standard sections for Items:''' Description, Obtaining, Usage, Crafting, History
* '''Standard sections for Mechanics:''' Overview, How it works, Strategy considerations, Related mechanics, History
* '''Standard sections for Vault Themes:''' Overview, Objectives, Rewards, Strategies, Gallery
* '''Standard sections for Vault Layouts:''' Description, Room types, Navigation tips, Gallery

=== Content Types ===

'''Items'''
* Always use the appropriate Infobox template
* Include clear description of the item's function
* Specify how the item is obtained
* List any crafting recipes using proper templates
* Include usage instructions where relevant

'''Mechanics'''
* Provide clear overview of how the mechanic works
* Explain interaction with other game systems
* Include relevant statistics or numerical values when available
* Link to related mechanics and items

'''Vault Themes and Layouts'''
* Describe the theme/layout clearly and objectively
* Include information about unique features or challenges
* List any exclusive rewards or mechanics
* Use galleries effectively to show visual examples

=== When to Create New Pages ===

'''Create a new page when:'''
* The subject has substantial unique content (more than 2-3 paragraphs)
* The item/mechanic has its own distinct identity in-game
* The content would make an existing page too long or unfocused

'''Expand existing pages when:'''
* The information naturally fits within the existing scope
* The addition is relatively brief
* The content is closely related to the existing subject

'''Create disambiguation pages when:'''
* Multiple distinct items/mechanics share the same name
* There's potential for confusion between similarly named subjects

== Images and Media ==

=== Image Guidelines ===
* Use high-quality screenshots when possible
* Crop images to focus on the relevant content
* Maintain consistent lighting and settings for item images
* Use PNG format for images with transparency needs
* Use JPEG for photographs and complex screenshots

=== Inventory Slot Images ===
* '''Critical:''' Images for use in the Inventory Slot module must be named starting with <code>Invitem_</code>
* The remainder of the filename should exactly match the in-game item name
* '''Example:''' <code>Invitem_Vault Sword.png</code> for the Vault Sword item
* Maintain consistent sizing and quality for these images

=== Image Descriptions ===
* Always include alt text for accessibility
* Write clear, descriptive captions
* Include relevant context (game version, location, etc.)

=== Galleries ===
* Use MediaWiki gallery syntax for multiple related images
* Group images logically (by type, location, etc.)
* Keep gallery images reasonably sized

== Templates and Categories ==

=== Template Usage ===
* Use established Infobox templates consistently for similar content types
* Follow existing template parameter naming conventions
* Don't create new templates without team discussion

=== Categories ===
* All Vault Hunters 3rd Edition content should use the <code><nowiki>{{VH3}}</nowiki></code> template
* Use categories to organize content logically
* Follow Wikipedia-style category hierarchy when possible
* Avoid over-categorization - use the most specific relevant categories

=== Linking ===
* Link to other wiki pages on first mention in each section
* Use piped links when the link text should differ from the page title
* Link to relevant external resources sparingly and only when necessary
* Avoid overlinking - don't link common terms in every paragraph

== References and Sources ==

=== When to Include References ===
* For specific numerical values or statistics
* When referencing official developer statements
* For information that might be disputed or updated
* When citing community discoveries or testing

=== Reference Format ===
* Use MediaWiki reference syntax: <code><nowiki><ref>Source information</ref></nowiki></code>
* Include date accessed for web sources
* Link to official sources when possible
* For in-game information, note the game version

=== Acceptable Sources ===
* Official Vault Hunters documentation
* Developer streams or announcements
* Verified community testing with clear methodology
* Other established gaming wikis (with proper attribution)

== Editing Guidelines ==

=== Before Making Major Changes ===
* Check the coordination system (currently spreadsheet, moving to Linear)
* Discuss significant structural changes with the team
* Consider the impact on existing links and references

=== Edit Summaries ===
* Always provide clear, descriptive edit summaries
* Use consistent terminology
* '''Good examples:'''
** "Added crafting recipe for Vault Sword"
** "Updated drop rates based on v3.14 changes"
** "Fixed typos in mechanics description"

=== Quality Control ===
* Preview changes before saving
* Check that links work correctly
* Verify template syntax and parameters
* Ensure images display properly

=== Peer Review Process ===
* Currently operating on peer approval basis
* Get feedback before major content additions
* Review others' work constructively
* Future: formal review workflow system planned

== Style Consistency ==

=== Numbers and Statistics ===
* Use exact numbers when available
* Round percentages to reasonable precision (usually 1-2 decimal places)
* Use consistent formatting for ranges (e.g., "5-10 items" not "5 to 10 items")

=== Lists and Formatting ===
* Use bullet points for unordered lists
* Use numbered lists for sequential processes
* Use consistent indentation
* Bold important terms on first use in a section

=== Common Terms ===
* Maintain consistent spelling and capitalization of Vault Hunters-specific terms
* Create a glossary section if needed for frequently used terms
* When in doubt, check existing pages for established usage

== Future Considerations ==

=== Strategy Content ===
* A separate strategy namespace may be added in the future
* Until then, keep strategy content minimal and objective
* Focus on mechanical information rather than subjective advice

=== Expansion Plans ===
* Style guide will evolve as the wiki grows
* New content types may require additional guidelines
* Template standards may be refined based on usage

----

''This style guide is a living document and will be updated as the wiki develops. For questions or suggestions, coordinate through the team's project management system.''