Documentation a Necessary Evil

Originally posted on: http://www.maxpears.com/category/blog/

Hey Team,

(Disclaimer: these are my opinions and only my opinions)

Hope everyone is doing well making/playing the games they love. After talking about mechanics, design theories, etc. I have decided to shed some light on an area of design which is not spoken about enough, often overlooked, despite it being an integral part of the design. (I know why, because it is not most fun part of the job, to be honest)

What got me thinking about this part of the design was a flashback to my very first post which started my journey on to blogging (http://www.maxpears.com/2015/08/26/communication/). It was about communication, how it is so essential to communicate with your team. Despite the team size, communication can break down so fast which can cause Huge issues. Now there are so many ways to communicate, which I touched upon briefly in my previous blog, one of these methods was DOCUMENTATION.

Documentation is not spoken about much due to the fact that it is often the least exciting part of the design (In my opinion at least). Sometimes some documentation is never updated when it should be or it was done retrospectively.

Now if I am being honest, I am not a fan of documentation but I know that it is extremely important when it comes to making video games. Now some of you may be thinking:

Well, I am glad you asked young Keanu Reeves (great hair). There are many reasons, so allow me to tell you them:

Those are some valuable reasons on why documentation is important, but documentation comes in all shapes and forms. Remember this because this is very important when communicating with all the other teams.

In games development, there are many disciplines which come together to create games, Art, Animation, Game Design, Level Design, QA, and much more. Each of these groups can read but all prefer to communicate in other ways. For example, me sending two pages of text would work better with the Story team instead of the art team. Because (and I am not lying here as I have been in situations when sending bullet point docs to Art members) the art team would prefer pictures and would understand what I am looking for more with references instead of a detailed description (a picture speaks a thousand words). Which leads me on to discussing how to create your documentation.

When creating documentation think about who is going to see this. Is it going globally or just a specific team or the set number of people across disciplines. Once you know this you can start to tailor your document to your audience to have the best impact. If you are speaking to directors, normally it is best to keep everything at a high level, yet in a review situation then you should reveal more details to them.

All of these topics should enter your mind when you are creating these documents:

Once you know the answer to these you can then start to plan accordingly, and make it sexy. It is very important,  to make it eye catching, seriously when your documents go out you need to make sure it hooks people. In games we get a lot of emails a day, each wanting a lot of attention so make sure yours has everyone! Just black text on a white background will not pull readers in. I know it is just a document and I am sure it has some great information, but you need to show it in a cool way that makes the reader want to learn more.

So there we have it, team, I hope this made you think a tad differently about documentation, and why it is important when it comes to making games. It is really is helpful on many levels and for a multitude of reasons. 

Remember moving forward that you should take creating documents serious because these can be the start of something special when it comes to designing your game. Make it look and feel as important as your game as this is how you will get other team members inspired as well as interested in your work.

If you want to chat hit me up on Twitter: @MaxPears

Thanks

Max