Jump to content
  • Advertisement
Sign in to follow this  
moeen k

how to write documentation

This topic is 2030 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

hi. im trying to write my new game documentation but in last ones i wrote it there was a lot of problem and i think i didnt do it in a standard way. as you may say there are a lots of ways to do that but i think there is some rules and standards to do that for example how to write the story that some parts are game play and some parts cutscences and writing gameplay design and relate it to other parts like story. can anyone help me to learn it better and give mea good compelete  source? thank you for helping and excuse me for my weak english

Share this post


Link to post
Share on other sites
Advertisement

You're talking about design documentation, correct? GDDs and TDDs, not user-facing documentation or code comments?

 

Look to screenplays and scripts for inspiration on how to handle cut-scenes or dialog. If you have interactive dialog (e.g. dialog trees a'la Fallout or other RPGs), you can combine this screenplay-style notation with flow-charts.

 

Other than that, I don't think there's any formal guidelines or standard format for writing GDDs and the like -- however, there are numerous articles on the topic, both for containing suggestions around organization and content. The only stand-alone tips I can offer is to not combine game design documentation together with technical design documentation--or, TDD-- (these should be separate documents), and also don't try to be overly prescriptive in either -- for example, your TDD shouldn't try to predict what classes or interfaces will be needed, but should describe what code systems there are, their responsibilities and non-responsibilities, and how they might fit together. The purpose of either document is to define your goals in concrete form, and to lay the very foundation -- its not to predict the in-between in every detail.

 

One place you could look for inspiration would be an edition of the Dungeons and Dragons book -- even if you're not designing anything like an RPG, you could still adapt what you find inside to your game; particularly the way that races and characters are described, items and their properties are enumerated, and the gameplay rules are described. You can probably find a cheap copy of an older edition in any used book store/game store; they rules have changed over the years, but that doesn't matter for your purposes.

Share this post


Link to post
Share on other sites
Sign in to follow this  

  • Advertisement
×

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

GameDev.net is your game development community. Create an account for your GameDev Portfolio and participate in the largest developer community in the games industry.

Sign me up!