STEP:Guide-Development Workflow: Difference between revisions

From Step Mods | Change The Game
mNo edit summary
mNo edit summary
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__[[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}}


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 [https://stepmodifications.org/forum/forum/149-supported-games/ Supported Games] forums. 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 mod-build guides will be prefixed with a yellow "{{fc|yellow|Testing}}" tag and tagged with the '[[Property:ModGroup|ModGroup]]' corresponding to the wiki mod page. These mods 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 prefix-tagged "{{fc|green|Accepted}}". The corresponding wiki mod pages directly feed information into guide ModGroup tables via the [[STEP:Mod-Build_Guide_Framework|custom framework]].
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 [https://stepmodifications.org/forum/forum/149-supported-games/ Supported Games] forums. 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 mod-build guides will be prefixed with a yellow "{{fc|yellow|TESTING}}" tag and tagged with the '[[Property:ModGroup|ModGroup]]' corresponding to the wiki mod page. These mods 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 prefix-tagged "{{fc|green|ACCEPTED}}". The corresponding wiki mod pages directly feed information into guide ModGroup tables via the [[STEP:Mod-Build_Guide_Framework|custom framework]].


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.
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.
Line 15: Line 15:
#* Knowledgeable community members will post some minimum criteria for testing, and {{fc|orange|Staff}} or the topic creator will update the testing topic's OP. It is expected that the community provide the mod testing detail that is requested in the OP. A mod will remain in the testing phase until the minimum testing criteria have been met.
#* Knowledgeable community members will post some minimum criteria for testing, and {{fc|orange|Staff}} or the topic creator will update the testing topic's OP. It is expected that the community provide the mod testing detail that is requested in the OP. A mod will remain in the testing phase until the minimum testing criteria have been met.
# '''Once adequately "tested", these mods will either be prefix-tagged as {{fc|green|ACCEPTED}} or {{Fc|red|DROPPED}}'''.
# '''Once adequately "tested", these mods will either be prefix-tagged as {{fc|green|ACCEPTED}} or {{Fc|red|DROPPED}}'''.
#* <span style="color:#00FF99"><b>[ ACCEPTED ]</b></span> mods:
#* {{fc|orange|Mod Testers}} or other advocates of accepted mods must [[STEP:Main|'''CREATE THE CORRESPONDING MOD PAGE''']].
#** {{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.
#* All mod topics --regardless of status-- will continue to be used for posting.
#** {{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.
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.


Thanks!
Thanks!

Revision as of 17:44, June 24, 2021

Delta c.png

Guide-Development Workflow

A high-level overview of community-driven guide ideation/creation

by: Step Modifications  | Forum Topic

Template:TOC right

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 Supported Games forums. 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 mod-build guides will be prefixed with a yellow "TESTING" tag and tagged with the 'ModGroup' corresponding to the wiki mod page. These mods 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 prefix-tagged "ACCEPTED". The corresponding wiki mod pages directly feed information into guide ModGroup tables via the custom framework.

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 Administrators, Step Admin, 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.

Please see our Member Groups as a reference for the member roles mentioned in this article.

Workflow Details

  1. Community Members post topics on the {Gamename} Mods forums according to the posting guidelines.
    • This is a continuous process, and many mods topics currently exist on the forums, so please search before posting!
    • Any mod can be posted in mod topics, but they must quality thresholds in order to be considered for mod-build guides.
    • These threads contain community feedback pertaining to the mod.
  2. Staff determine which mods will be prefix-tagged for testing based largely on mods called out by Members.
    • Knowledgeable community members will post some minimum criteria for testing, and Staff or the topic creator will update the testing topic's OP. It is expected that the community provide the mod testing detail that is requested in the OP. A mod will remain in the testing phase until the minimum testing criteria have been met.
  3. Once adequately "tested", these mods will either be prefix-tagged as ACCEPTED or DROPPED.
    • Mod Testers or other advocates of accepted mods must CREATE THE CORRESPONDING MOD PAGE.
    • All mod topics --regardless of status-- will continue to be used for posting.

Once mods are accepted and the corresponding mod pages created, Administrators and 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.

Thanks!

Retrieved from "https://stepmodifications.org/wiki/index.php?title=STEP:Guide-Development_Workflow&oldid=155806"