-
-
Notifications
You must be signed in to change notification settings - Fork 40
Meta Documentation
Valkyrien Warfare documentation can be available in the following forms:
The Github README and Curseforge page of the mod should be similar in format. They should contain the mod's name centered in the screen, along with a screenshot clearly demonstrating what the mod is all about.
The second most obvious thing should be clear and concise instructions on how to download and install the primary release of the mod.
Following that, a basic "quick start" guide augmented with pictures, explaining what to do to get started with the mod, in as little steps as possible. This should also link to the video quick start guide, seen below in the tutorials section.
Optimally, the Valkyrien Warfare wiki should be accessible in-game through a book.
The Valkyrien Warfare wiki should contain a more technical documentation . It should detail information pertaining to how the mod works, such as ship spaces, local position, global position, control system extensions, and more.
It should also contain detailed information about various components of the mod on separate pages. Pages mentioning others should link to each other, Wikipedia-style.
The in-game tutorial should automatically update to reflect the wiki page on the tutorial of the mod (see Wiki section).
It should link to the tutorial video and include a concise quick start explanation followed by a more detailed explanation of everything. It need not be completely comprehensive. It should include pictures.
There should be at least two video tutorials, one a detailed, ~20 minute explanation of most of the mod's features. It should be thorough but concise, with no extraneous rambling and all unnecessary pauses cut out.
The other should be a visual version of the quick start guide. It should be 1-3 minutes in length, with clear instructions, no extraneous rambling, and all unnecessary pauses cut out.