Difference between revisions of "Documenting your artefacts"

From Elite Wiki
(Created page with "Once you created an OXP and want to show it to the world, you probably want to advertize the expansion's features. But players may also need some knowledge about the ships or...")
 
Line 6: Line 6:
 
* Optional: If you want to go further, create additional pages for all ships and equipment using their names as page title.
 
* Optional: If you want to go further, create additional pages for all ships and equipment using their names as page title.
  
The [[Project:Oolite Documentation Project]] is trying to cleanup technical debt in this respect.
+
The [[Oolite Documentation Project]] is trying to cleanup technical debt in this respect.

Revision as of 06:26, 7 June 2021

Once you created an OXP and want to show it to the world, you probably want to advertize the expansion's features. But players may also need some knowledge about the ships or equipment that you created. For example, if you create a new equipment type foo others will want to know what it is, what it does and how to use it. So how to do it?

  • Mandatory: At least create a wiki page with the page title identical to the expansion's name (as mentioned in the manifest, not the filename).
  • Optional: If you want to go further, create additional pages for all ships and equipment using their names as page title.

The Oolite Documentation Project is trying to cleanup technical debt in this respect.