STEP:Guide-Development Workflow

Step Guide-Development Process

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

by: Step Modifications  | Forum Topic

WIP

This guide is still under development and awaiting updates.

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.

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

  

• 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

      

   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

      

   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

   

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.