STEP:Guide-Development Workflow: Difference between revisions

From Step Mods | Change The Game
 
(40 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTITLE__[[Category:Step Guides]]{{PageTitle|logo=delta|title=Guide-Development Workflow|subtitle=A high-level overview of community-driven guide development|author=Step Modifications|forumtid=4933}}{{TOC}}
__NOTITLE____NOTOC__[[Category:Step Guides]]{{PageTitle|logo=delta|title=Step Guide-Development Process|subtitle=A high-level overview of Step Modifications' Modding Guide development process|author=Step Modifications|forumtid=4933}}


In order for the mod-build guides to remain relevant, it is imperative that this generalized workflow be maintained by staff, guide Curators, and community contributors. Certain parts of the current workflow are restricted to {{fc|orange|Administrators}}, {{fc|orange|Step Admin}}, {{fc|purple|Step Curators}}, and guide Curators; however, most of the workflow is exposed to all community members. It's this functionality that is presented here along with a breakdown of the update workflow. It's important that the community help drive the process, because it takes a lot of time to maintain the entire workflow and all of the quality assurance that goes along with it.
The Development Process is used for all Modding Guide development cycles. This process includes on-going maintenance tasks, as well as, release and post-release procedures; which are covered below. Each Modding Guide can be a little unique so not all guides may use everything described.


''This workflow assumes the corresponding Development Guide and Mod List have already been propagated, which are covered in [[STEP:Mod-Build_Guide_Framework#Step_4:_Create.2FUpdate_ModList|Step 4]] and [[STEP:Mod-Build_Guide_Framework#Step_5:_Propagate_Guide.2FChangelog|Step 5]] of the Mod-Build Guide Framework article.''  
{{Alert|type=notice|text='''Notice to Staff'''<br>In order for Game Guides to remain relevant, it is imperative that this generalized workflow be maintained by staff, Curators, and community contributors.<br><br>''This workflow assumes the corresponding Development Guide and Mod List have already been propagated, which are covered in [[STEP:Mod-Build_Guide_Framework#Step_4:_Create.2FUpdate_ModList|Step 4]] and [[STEP:Mod-Build_Guide_Framework#Step_5:_Propagate_Guide.2FChangelog|Step 5]] of the Mod-Build Guide Framework article.''}}


''Please see our [[Guide:STEP_Community_Citizenship#Member_Groups|Member Groups]] as a reference for the member roles mentioned in this article.''
== Wiki Maintenance ==
The below is the general maintenance for the wiki that takes place throughout the development process.


== Mod Testing ==
=== Changing Dev Version Post Propagation ===
The Step forums serve as one component of release development for mod-build guides. Any registered members may post a new topic in one of the ''<GameName> Mods'' forums within our [[Property:Game|supported game]] forums. These mod topics serve as the "catch-all" for information and feedback relating to the any specific mod for both staff and guide curators. These forums have specific prefixes available, which are reserved for official Step use.
Unless the Modding Guide is new, the Dev version typically already exists from previous releases. In the rare event a Dev Guide changes versioning during the course of development due to more extensive changes than initially planned (e.g, ''Dev v2.7'' becomes ''Dev v3.0'' ), then the following is how to update the versioning mid-development:


From member suggestions and staff recommendations, any topic may be tagged for consideration for an official mod-build guide. Mods being actively considered will be prefixed with {{fc|yellow|TESTING}} and tagged with the proper '[[Property:ModGroup|ModGroup]]' tag. These mod topics can be filtered by clicking on the tag itself. All testing feedback is done on the individual topic for that specific mod. If a given mod "passes" testing, then its topic will be prefixed with {{fc|green|ACCEPTED}}. The corresponding wiki mod pages directly feed information into guide ModGroup tables via the [[STEP:Mod-Build_Guide_Framework|custom framework]].
WIP


=== Mod Testing Workflow ===
=== Mod Pages ===
====== Mod Topics (any member) ======
* Create mod pages for all new {{fc|green|text=ACCEPTED}} mods
* If the mod topic doesn't exist, create a new one on the {GameName} Mods forum using the Mod Topic editor tool. [[File:Ckeditor-modtopic.JPG|450px|right]]
* Ensure new mod pages are complete with version-specific pages created, flags set, and correct guide-related instructions
* Any member can suggest mods for inclusion into a guide by creating the topic or posting on on an existing topic.
* Ensure mods that were moved to new Mod Groups have had their Mod Group changed on their mod page
* Suggesting a mod for inclusion into an official guide should be accompanied with a review and a rationale for the suggestion.


====== Tag Mod for Testing (staff) ======
== Forum Maintenance==
Staff determine whether or not suggested mods are candidates for official testing if they meet the [[STEP:Mandate|Mandate requirements]].
The below is the general maintenance for the forums that takes place throughout the development process.
# Edit the mod topic, and add the following tags:
* Ensure all new {{fc|green|ACCEPTED}} topics are named correctly: <code>NexusName (by AuthorName)</code>
## Add the {{fc|yellow|TESTING}} ''prefix''.
* Ensure all new {{fc|green|ACCEPTED}} topic OPs are formatted with the correct mod topic header
## Add the [[Property:ModGroup|ModGroup]] tag.
*: [[File:Ckeditor-modtopic.JPG|600px|frameless|border]]
## Add the {{fc|salmon|guide version tag}} (format as #.#.#). This creates the version-testing context for posterity. E.g., If we don't accept the mod and later consider it, we are reminded that it was under testing for this guide version.
* Ensure the {{fc|yellow|TESTING}} prefix has been removed from all new {{fc|green|ACCEPTED}} mods. Mods not accepted can keep their {{fc|yellow|TESTING}} prefix, if testing is planned to continue for the next release; else, the prefix should be removed.
# Add minimum criteria and instructions for testing to opening post BELOW the horizontal line.
*# From the Topic view, tick the box at right of the {{fc|green|ACCEPTED}} topic
# [[STEP:Main#Creating_Mod-Build_Guides|Create the mod page]] - Copy the topic name (excluding authors) to create the mod page on the wiki (see [[STEP:Mod-Build_Guide_Framework#Step_1:_Create.2FUpdate_Mod_Pages|creating/updating mod pages]]).
*# Select '''Unmark for Testing''' from the menu in the tool pop-up at lower right
* Ensure all mods that were dropped from a Guide have been prefixed as {{fc|red|DROPPED}} and their {{fc|green|ACCEPTED}} prefix/tags removed


====== Mod Testing (any member) ======
== Nexus Maintenance ==
In order to test a mod for Step, any member may contribute evidence.
Unless the Modding Guide is new, the Nexus page should already exist. Since Nexus pages are mainly static, there is no required on-going maintenance.
{{Alert|text=Anyone testing a mod for a new Step guide ''MUST have a complete and current Step install'', including the mod being tested as well as any other mods in testing that could impact the testing mod. In other words, testers must have installed the Step guide in full and including all relevant mods in testing (and any mods tagged as {{Fc|red|DROPPED}} in the dev iteration should be disabled).}}
* Review the OP of any mod topic having the 'testing' prefix.
* If the mod makes visible changes to content, provide screenshot compares using the following standard series in a reply to the topic.
*# {{Fc|salmon|Vanilla reference (first) screenshot:}} Step dev guide ''excluding'' any mods making changes to the content affected by the mod being tested. If no mods make such changes, then state as much in the post and skip this screenshot.
*# {{Fc|salmon|Step reference (second) screenshot:}} Step dev guide ''including'' all mods plus any ACCEPTED mods for the current development version.
*# {{Fc|salmon|Step With Test Mod (third) screenshot:}} Step dev guide ''including'' all mods with the 'testing' mod content overriding.
* If the mod doesn't make visible changes or said changes are not practical to compare via screenshots, then provide alternative context and assessment.
* If the mod receives a positive review and is advocated by at least two staff, it should be tagged {{Fc|green|ACCEPTED}} using the "Saved Action" tool after selecting a topic (or from inside the topic using the "Moderator Actions" button).
* If the mod does not receive a positive review and is not advocated by at least two staff ...
** NEVER tag these as {{fc|red|DROPPED}}, which is ONLY used after a mod has been accepted in a previous guide version.
** Remove the {{fc|yellow|TESTING}} prefix using the "Saved Action" tool after selecting a topic (or from inside the topic using the "Moderator Actions" button).


== Mod Incorporation / Removal ==
== Release Procedures ==
Once the mod testing phase is complete, the workflow moves entirely to the wiki. Staff and Curators will add or remove mods from the guides by editing the corresponding guide's Mod List.
The checklist is to be completed in the order listed for every Modding Guide release to ensure a smooth release. Be aware, some of the step are re-verifying general workflow maintenance was completed. Do not skip these steps! They exist for quality assurance purposes.
# Check, double-check, and finalize the Dev Changelog
Workflow-related activities combined with site & workflow maintenance, Guide upkeep, and Nexus upkeep require almost all of the senior staff's time, therefore, we ask that the community help out by supplying the needed information and contributing to site maintenance wherever possible.
# Complete a final edit to Dev Mod List ensuring it matches the Dev Changelog
## Enter the '''GameName DEV''' version in the first textbox and click the '''Edit Existing''' button
##: [[File:Create or Edit ModList.PNG|500px|frameless|border]]
## Verify the {{fc|red|DROPPED/REPLACED}} mods have been removed, the {{fc|orange|MOVED}} mods have been relocated in the Mod List, and the newly {{fc|green|ACCEPTED}} mods have been added
# Visit the Modding Guide's Nexus page
## Hide the Nexus page, providing a description that an update is underway and the page will return shortly
## Update the Nexus changelog with the appropriate information
## Update Credit section, if applicable
## Upload any new files to Nexus, replacing the previous ones using the same naming scheme
## Leave the Nexus page open for later steps
# On the Step forums
## Close the previous release's '''Feedback & Bug Reports''' topic, unpin and lock it
## Create a new '''Feedback & Bug Reports''' topic, pin it (edit the links accordingly)
## Close old Dev topics found with the guide's Administration forum and start new one (edit, pin/unpin accordingly)
# Revisit the Modding Guide's Nexus page
## Update the Nexus description using the '''BBCode''' view and revise all guide and changelog links, feedback links, etc.
## Unhide/publish the page
# Return to the forum
## Post a new Release topic in the Announcement forum, feature and pin it
## Unfeature, unpin, and lock the previous release's announcement topic
# Post or request an Admin post an announcement to Step's Facebook page regarding the new guide release


Thanks!
== Post-release Procedures ==
=== Guide Propagation ===
# Ensure the '''GameName DEV''' version corresponds to the new development release version! ''{{fc|instruction|If this is not set correctly, then the platform will not behave as expected!}}''
## Open the [[STEP:Main|Step Portal]]
## Edit '''Guide Versioning''' by clicking the '''Create or edit''' button
##: [[File:VersioningUpdate.png|650px|frameless|border]]
## Change the '''GameName DEV''' number to the new dev release number for the respective Modding Guide.
## {{fc|warning|text=''Change NOTHING else! Simply save the page.''}}
# From the Game's Portal, copy new Dev Guide
# From the Game's Portal, copy new Dev Changelog
#: [[File:GamePortalNav.png|140px|frameless|border]] [[File:Propagate_or_Edit_Guide.png|500px|frameless|border]]
# Propagate new a Mod List for the development release by entering the new '''GameName DEV''' version into the second textbox and click the '''Propagate''' button.
#: [[File:Create or Edit ModList.PNG|500px|frameless|border]]

Latest revision as of 15:00, September 29, 2023

Delta c.png

Step Guide-Development Process

A high-level overview of Step Modifications' Modding Guide development process

by: Step Modifications  | Forum Topic

The Development Process is used for all Modding Guide development cycles. This process includes on-going maintenance tasks, as well as, release and post-release procedures; which are covered below. Each Modding Guide can be a little unique so not all guides may use everything described.

Info-Logo.png

NOTE

Notice to Staff
In order for Game Guides to remain relevant, it is imperative that this generalized workflow be maintained by staff, Curators, and community contributors.

This workflow assumes the corresponding Development Guide and Mod List have already been propagated, which are covered in Step 4 and Step 5 of the Mod-Build Guide Framework article.

Wiki Maintenance[edit | edit source]

The below is the general maintenance for the wiki that takes place throughout the development process.

Changing Dev Version Post Propagation[edit | edit source]

Unless the Modding Guide is new, the Dev version typically already exists from previous releases. In the rare event a Dev Guide changes versioning during the course of development due to more extensive changes than initially planned (e.g, Dev v2.7 becomes Dev v3.0 ), then the following is how to update the versioning mid-development:

WIP

Mod Pages[edit | edit source]

  • Create mod pages for all new ACCEPTED mods
  • Ensure new mod pages are complete with version-specific pages created, flags set, and correct guide-related instructions
  • Ensure mods that were moved to new Mod Groups have had their Mod Group changed on their mod page

Forum Maintenance[edit | edit source]

The below is the general maintenance for the forums that takes place throughout the development process.

  • Ensure all new ACCEPTED topics are named correctly: NexusName (by AuthorName)
  • Ensure all new ACCEPTED topic OPs are formatted with the correct mod topic header
    Ckeditor-modtopic.JPG
  • Ensure the TESTING prefix has been removed from all new ACCEPTED mods. Mods not accepted can keep their TESTING prefix, if testing is planned to continue for the next release; else, the prefix should be removed.
    1. From the Topic view, tick the box at right of the ACCEPTED topic
    2. Select Unmark for Testing from the menu in the tool pop-up at lower right
  • Ensure all mods that were dropped from a Guide have been prefixed as DROPPED and their ACCEPTED prefix/tags removed

Nexus Maintenance[edit | edit source]

Unless the Modding Guide is new, the Nexus page should already exist. Since Nexus pages are mainly static, there is no required on-going maintenance.

Release Procedures[edit | edit source]

The checklist is to be completed in the order listed for every Modding Guide release to ensure a smooth release. Be aware, some of the step are re-verifying general workflow maintenance was completed. Do not skip these steps! They exist for quality assurance purposes.

  1. Check, double-check, and finalize the Dev Changelog
  2. Complete a final edit to Dev Mod List ensuring it matches the Dev Changelog
    1. Enter the GameName DEV version in the first textbox and click the Edit Existing button
      Create or Edit ModList.PNG
    2. Verify the DROPPED/REPLACED mods have been removed, the MOVED mods have been relocated in the Mod List, and the newly ACCEPTED mods have been added
  3. Visit the Modding Guide's Nexus page
    1. Hide the Nexus page, providing a description that an update is underway and the page will return shortly
    2. Update the Nexus changelog with the appropriate information
    3. Update Credit section, if applicable
    4. Upload any new files to Nexus, replacing the previous ones using the same naming scheme
    5. Leave the Nexus page open for later steps
  4. On the Step forums
    1. Close the previous release's Feedback & Bug Reports topic, unpin and lock it
    2. Create a new Feedback & Bug Reports topic, pin it (edit the links accordingly)
    3. Close old Dev topics found with the guide's Administration forum and start new one (edit, pin/unpin accordingly)
  5. Revisit the Modding Guide's Nexus page
    1. Update the Nexus description using the BBCode view and revise all guide and changelog links, feedback links, etc.
    2. Unhide/publish the page
  6. Return to the forum
    1. Post a new Release topic in the Announcement forum, feature and pin it
    2. Unfeature, unpin, and lock the previous release's announcement topic
  7. Post or request an Admin post an announcement to Step's Facebook page regarding the new guide release

Post-release Procedures[edit | edit source]

Guide Propagation[edit | edit source]

  1. Ensure the GameName DEV version corresponds to the new development release version! If this is not set correctly, then the platform will not behave as expected!
    1. Open the Step Portal
    2. Edit Guide Versioning by clicking the Create or edit button
      VersioningUpdate.png
    3. Change the GameName DEV number to the new dev release number for the respective Modding Guide.
    4. Change NOTHING else! Simply save the page.
  2. From the Game's Portal, copy new Dev Guide
  3. From the Game's Portal, copy new Dev Changelog
    GamePortalNav.png Propagate or Edit Guide.png
  4. Propagate new a Mod List for the development release by entering the new GameName DEV version into the second textbox and click the Propagate button.
    Create or Edit ModList.PNG
Retrieved from "https://stepmodifications.org/wiki/index.php?title=STEP:Guide-Development_Workflow&oldid=187183"