#game design document structure

1 messages · Page 1 of 1 (latest)

fathom nacelle
#

Do we want structured by large categories or do we want completely everything in the root folder?

some examople categories:

  • Gameplay
  • Code guidelines
prime talon
#

well first of all I'd say that something like code guidelines is completely separate from game design analysis and doesn't belong in that repo at all

fathom nacelle
prime talon
#

I really don't think that contributing guidelines should be in that document in this case when GitHub has a specific place (.github/CONTRIBUTING.md) for them so that they get displayed when you're making a pull request

#

plus, we'll need a whole repo for a docs website anyway (be it using Writerside, docFx, Read the Docs or whatever else)

#

so in this case where it's a cloud-hosted open source project I think it makes more sense for the technical documentation to be separate from the living game design document

vague glen
prime talon
#

yeah same, I was looking at it mainly for docs for KSP2 mods but ended up also using it at work

nimble bough
#

usually the tech doc and gdd are seperate, same with the art bible as they call it

#

btw google docs allows for collaborative editing

kind hound
#

I think a google document should be the starting point, more advanced documentation can come after there is actually completed work to be documented

#

it would be best to have all the general basics and everyone's reasonable proposals all in one place instead of scattered amongst untold numbers of discord messages in random threads and many channels