MegaMek / megamek

MegaMek is a networked Java clone of BattleTech, a turn-based sci-fi boardgame for 2+ players. Fight using giant robots, tanks, and/or infantry on a hex-based map.
http://www.megamek.org
GNU General Public License v2.0
297 stars 287 forks source link

Documentation review prior to the 'Big Five-Oh' release #4413

Open SuperStucco opened 1 year ago

SuperStucco commented 1 year ago

Over the years the documentation has become somewhat scattered, with different contributions, file formats, styles, and the contents are not always kept up to date with what the code actually does. There is sufficient "How to set up a game/campaign" documentation, but there is very little in the way of what I would consider technical documentation i.e. this is what this button does, that button brings up this dialog which is used for _____ purpose, and so on. I get it - not enough people, higher priorities. And lets face it, writing documentation is not very fun compared to working on the code to solve a technical problem or add a highly desired feature, so documentation always gets pushed down the priorities list. I get the same problem when I'm working on engineering software, which snowballed to the point where I had to force myself to dedicate one day a week to only documentation work to avoid it looking like a ball of duct tape that Red Green would be proud of.

To that end, I would suggest a dedicated documentation review and modernization project be started sometime prior to the big 0.50 release. Although nice to have if it was finished prior to that, it isn't something that would necessarily block its release. It would cover the following points, and perhaps others:

This is a huge ask, so I would have no problems making contributions to assist with data entry/writing, reviewing content, and even some project management if required.

HammerGS commented 1 year ago

We are a long way from .5

While docs are always our weakness, we are currently a team with a couple of part time devs we just don't have the resources to do this. If the dev's stop to write documentation it will stop all forward movement on bug fixes and development.

We have asked for help from community for years, and always have people step up and instantly quit when they realize the scope of work to do this.

This is a huge ask, so I would have no problems making contributions to assist with data entry/writing, reviewing content, and even some project management if required.

My suggestion is ask on the Discord, set up a team and I please find attached the original handbook that you can update from.

MegaMek_Handbook_v1.docx

BLR-IIC commented 1 year ago

I'm interested in helping out with this as I've expressed on Discord. Notes from today: