STEP:Guide-Development Workflow: Difference between revisions

From Step Mods | Change The Game
mNo edit summary
 
(99 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTITLE__[[Category:Administration]][[Category:Reference]][[Category:How-To Guides]]{{PageTitle|logo=delta|title=Guide-Development Workflow|subtitle=A high-level overview of community-driven guide ideation/creation|author=Step Modifications|forumtid=4933}}{{TOC right}}
__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}}


The Step forums serve as one part of Step's vehicle for release development. Any registered members may post a new topic in one of the ''<GameName> Mods'' forums within our [https://stepmodifications.org/forum/forum/149-supported-games/ Supported Games] forums ({{fc|notice|see posting instructions at top of the forums before posting}}). These mod topics serve as the "catch-all" for information and feedback relating to the any specific mod. Mods being actively considered for one of the official game guides will be tagged with a yellow "{{fc|yellow|Testing}}" prefix tag. These mods can be filtered by clicking on the tag or visiting [https://stepmodifications.org/forum/tags/testing/ here]. All testing feedback is done on the individual topic for that specific mod. If a given mod "passes" testing, then its topic will marked with an "{{fc|green|Accepted}}" tag, as well as, guide-specific tags. The wiki pages directly feed the official Step Guides via our [[STEP:Mod-Build_Guide_Framework|custom framework]].
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.


Thus, in order for the game guides to remain current, it is imperative that this generalized workflow be maintained by the community. Certain parts of the current workflow are restricted to {{fc|orange|Administrators}}, {{fc|orange|Step Admin}}, {{fc|purple|Step Curators}}, and unofficial guide Curators; however, most of the workflow is exposed to all community members. It's this functionality that is presented here along with the linear 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.
{{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 below.''
== Wiki Maintenance ==
The below is the general maintenance for the wiki that takes place throughout the development process.


=== Release Workflow Details ===
=== Changing Dev Version Post Propagation ===
# <span style="font-weight:bold; color:#e6b69e;">Community {{fc|#70E2FF|Members}} post threads on the [https://stepmodifications.org/forum/forum/32-mods/ Mods] forum according to the posting guidelines.</span>
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:
#* This is a continuous process, and many mods currently exist in MS, so please search before posting!
#* Any mod can be posted in MS, but they must be of a specific quality in order to be considered for STEP. Hosever, all mods are considered for Packs.
#* These threads contain community feedback pertaining to the mod.
# <span style="font-weight:bold; color:#e6b69e;">Community {{fc|#70E2FF|Members}} post on the current release [https://stepmodifications.org/forum/forum/48-step-current-release-development/ vx.x.x Development Thread], calling out specific mods in MS that are particularly "hot" for STEP inclusion.</span> These mods should be fairly well researched by the poster.
#* Anyone posting in the Development Thread should be prepared to act as {{fc|#9ACD32|Mod Testers}} for any mods being advocated or disavowed. ALL {{fc|#70E2FF|Members}} can act as mod testers. These members will be credited accordingly for their work within the STEP Guide for that release.
# <span style="font-weight:bold; color:#e6b69e;">{{fc|#FFA800|Administrators}} or {{fc|#d5af78|STEP Staff}} determine which mods in the Mods forum will be called out for testing based largely on mods called out by {{fc|#70E2FF|Members}} on the Development Thread.</span>
#* {{fc|#FFA800|Administrators}} or {{fc|#d5af78|STEP Staff}}  will tag these mods for Testing by appending the '''[ TESTING ]''' tag
#* Knowledgeable community members will post some minimum criteria for testing, and {{fc|#D4A1F7|Moderators}}, {{fc|#D4A1F7|Super Moderators}}, {{fc|#d5af78|STEP Staff}} or {{fc|#FFA800|Administrators}} will update the testing topic's OP. It is expected that the community provide the mod testing detail that is requested in the OP (particularly the [https://stepmodifications.org/forum/forum/48-step-current-release-development/ Development Thread] advocates). A mod will remain in the testing phase until the minimum testing criteria have been met.
# <span style="font-weight:bold; color:#e6b69e;">Once adequately "tested", mods under testing will be either tagged as <span style="color:#00FF99">[ ACCEPTED ]</span> OR moved back into the Mods forum.</span>
#* <span style="color:#00FF99"><b>[ ACCEPTED ]</b></span> mods:
#** {{fc|#9ACD32|Mod Testers}} or other advocates of accepted mods must [[STEP:Main|'''CREATE THE CORRESPONDING MOD PAGE''']] on the STEP Wiki PRIOR TO RELEASE. {{fc|#D4A1F7|Moderators}}, {{fc|#FFA800|Administrators}}, or {{fc|#d5af78|STEP Staff}} will update the OP and the wiki mod page with these notes. NOTE: Mod pages must also be created if they do not already exist for inclusion into any Pack.
#** {{fc|#9ACD32|Mod Testers}} or other advocates of accepted mods must specify any pertinent installation notes pertaining to the mod ON THE MOD'S TOPIC. PRIOR TO RELEASE.
#** {{fc|#FFA800|Administrators}} or {{fc|#d5af78|STEP Staff}} will move accepted mods into the STEP Mod Anthology on the release date (the original Mod topic redirect will remain and point now to the Anthology).
#* All threads, regardless of acceptance into STEP, will continue to be used for posting as per usual, since the Mods forum should, theoretically, house all mod topics.


Once mods are accepted and the corresponding mod pages created, {{fc|#FFA800|Administrators}} and {{fc|#d5af78|STEP Staff}} are able to incorporate new mods into the current STEP Development Guide. 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.
WIP


Thanks!
=== Mod Pages ===
* Create mod pages for all new {{fc|green|text=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==
The below is the general maintenance for the forums that takes place throughout the development process.
* Ensure all new {{fc|green|ACCEPTED}} topics are named correctly: <code>NexusName (by AuthorName)</code>
* Ensure all new {{fc|green|ACCEPTED}} topic OPs are formatted with the correct mod topic header
*: [[File:Ckeditor-modtopic.JPG|600px|frameless|border]]
* 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.
*# From the Topic view, tick the box at right of the {{fc|green|ACCEPTED}} topic
*# 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
 
== Nexus Maintenance ==
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 ==
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
# 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
 
== 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

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

Changing Dev Version Post Propagation

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

  • 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

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

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

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

Guide Propagation

  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"