Documentation structure - barsandcat/HMS-Sunflower GitHub Wiki

Documentation for communication with the world:

  • Pitch. Purpose: to sell the game idea

Concept documentation. An input for decision making.

  • Art bible - describes intended look and feel of game.
  • Lore - describes world of the game.
  • Character page.
  • Use case - describes how game behaves. Purpose: to illustrate how system design should work

Game design documentation. Primary documentation. Describes goals. Includes technical design documentation. Contains decision logs: why and why nots:

  • System design - describes game mechanic or game system structure.
  • Story design - describes entire story tree, what player options are, and what happens.
  • Ship building design - describes ship building puzzle.

Development documentation.

  • Manuals. Describe how tools for development works.
  • Feature documentation. Describe how game systems and game mechanics currently work - for QA to differentiate between bugs and functionality

Project documentation

  • Planning and tracking