Guide:Wiki Maintenance: Difference between revisions
From Step Mods | Change The Game
TechAngel85 (talk | contribs) |
TechAngel85 (talk | contribs) |
||
Line 59: | Line 59: | ||
Like the cheatsheet... | Like the cheatsheet... | ||
== General Formatting Tips == | |||
=== Writing Style === | === Writing Style === | ||
When writing content outside of the userspace, the [https://en.wikipedia.org/wiki/Grammatical_person third-person writing style] should be used. Other writing styles are acceptable, depending upon the particular context of the article; however, any factual content created to serve as an informative article (e.g., guides and references) should be written in the third person. This is more clear and professional and not as prone to degenerating into a mess of first-second person reversions. Any content that exist outside userspaces and is also not written in the third person should be corrected accordingly. Examples: | When writing content outside of the userspace, the [https://en.wikipedia.org/wiki/Grammatical_person third-person writing style] should be used. Other writing styles are acceptable, depending upon the particular context of the article; however, any factual content created to serve as an informative article (e.g., guides and references) should be written in the third person. This is more clear and professional and not as prone to degenerating into a mess of first-second person reversions. Any content that exist outside userspaces and is also not written in the third person should be corrected accordingly. Examples: | ||
Line 64: | Line 65: | ||
* {{fc|red|Second person: "You first must click on the 'edit' button ..."}} | * {{fc|red|Second person: "You first must click on the 'edit' button ..."}} | ||
* {{fc|green|Third person: "First, click on the 'edit' button ..."}} | * {{fc|green|Third person: "First, click on the 'edit' button ..."}} | ||
== Specific Formatting Situations == | |||
=== Instruction Sets === | |||
Follow these guidelines when writing instructions: | |||
* When instructing a user to 'click' or 'select' any UI element: use the [[:Template:Ui|Ui]] template, as in the following example: | |||
**<code><nowiki>Click {{ui|Edit}}, then right click {{ui|some UI element}} ...</nowiki></code> | |||
**Click {{ui|Edit}}, then right click {{ui|some UI element}} ... | |||
* When referring to messages in the UI: Italicize the UI message, and do not highlight it in any other way. | |||
* In-line headings: If you have several bullets or paragraphs in a row which each refer to a certain topic, you may use bold, peach-colored formatting to highlight the topic of each bullet or paragraph, as in the following example: | |||
**<code><nowiki>{{fc|important|'''First Topic Name.'''}} This paragraph explains the first topic. Other paragraphs will have their own in-line headers and explanations.</nowiki></code> | |||
**{{fc|important|'''First Topic Name.'''}} This paragraph explains the first topic. Other paragraphs will have their own in-line headers and explanations. | |||
**[https://stepmodifications.org/wiki/Guide:DDSopt#Main_Menu_Setting_Descriptions Working Example] | |||
=== Symbols === | === Symbols === |
Revision as of 20:41, June 17, 2021
Wiki Maintenance Guide
Standards and tips for editing the Step wiki
by: Step Modifications | Forum Topic
Definition of a wiki:
- "...a website or database developed collaboratively that allows users to add, delete, or revise content by using a web browser."
The Step Modifications wiki is intended to be a community-driven project; although, most contributions to date have originated from only a handful of contributors. Our goal is to make it easy for all community members to contribute by helping us maintain existing content and developing new content. We created this reference to help our userbase get more comfortable working within a wiki environment.
Maintenance Sections[edit | edit source]
Need Help?[edit | edit source]
Private message one of these guys if you need some sort of help with The Wiki.
Primary Wiki Editors/Maintainers[edit | edit source]
Always looking for others!
- z929669
- DoubleYou (MO & STEP Guides primarily)
- TechAngel85