SUBSIM Radio Room Forums



SUBSIM: The Web's #1 resource for all submarine & naval simulations since 1997

Go Back   SUBSIM Radio Room Forums > Silent Hunter 3 - 4 - 5 > SH5 Mods Workshop
Forget password? Reset here

 
 
Thread Tools Display Modes
Prev Previous Post   Next Post Next
Old 03-08-10, 11:47 AM   #1
TheDarkWraith
Black Magic
 
Join Date: Jun 2007
Posts: 11,962
Downloads: 147
Uploads: 5


Default A suggestion for proper documentation

For those of you that are creating new items/changing/tweaking SH5 I applaud you I have one concern and to me, it's a big one.
I love seeing new things being released for the game. It's great. What I would like to see is proper documentation of what you did/ what you changed. That way one can evaluate what you did and then if another user wants to change it to their liking they can easily 'tweak' the change you made. If not, a mod soup is going to quickly develop and it's going to be hell trying to figure out if this mod will break/cause hassles with this mod. With the changes listed, a developer can look at the file and see that mod A is using these files and made these changes. Then they can contact the other person and work with them to incorporate their changes (if need be) or see if it's ok to use those changes in their mod.
This will greatly simply merging many little (or even big) mods into one so called super-mod.
I'd like to see this documentation listed in the \documentation folder of the mod. Format of something like this:

parameter, old value, new value, reason for change (experiment, incorrect value, etc.).
TheDarkWraith is offline   Reply With Quote
 

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump


All times are GMT -5. The time now is 03:30 PM.


Powered by vBulletin® Version 3.8.11
Copyright ©2000 - 2025, Jelsoft Enterprises Ltd.
Copyright © 1995- 2025 Subsim®
"Subsim" is a registered trademark, all rights reserved.