This was an assignment for the class ENGL 302 Buisness Communication. I took away many valuable things from this course, including the power of “you” centered language as well as a disciplined look at my writing. This assignment was to create an analysis of documentation in a field that I could see myself working in.
Date: | January 19th, 2017 |
To: | Graduating Seniors Majoring in Technical Communication |
From: | Dean LeClaire |
Subject: | Writing Patch Notes in the Workplace |
Patch notes, also known as Change Logs, are commonly seen in the videogames industry and this memo will describe the expectations for writing and formatting this style of document.
The Purpose of Patch Notes and their Audience
Patch Notes are pieces of communication that document changes made between different versions of a product. In videogames, patch notes show the changes between different versions of the game. These changes often include:
- New Content
- Balance Changes
- Bug Fixes
- Improvements to the Overall Game Experience
Patch notes are a direct way of communicating these changes to the people playing the game being updated. Good patch notes build goodwill with your existing player base, potentially bring back veteran players, and even introduce new played to your game.
The Structure of Patch Notes
At its most basic form, patch notes are a simple series of softly formatted text on a page. Because patch notes often have news about content or game fixes, basic formatting is sometimes sufficient, such as in the Star Citizen patch notes (Baior Of Red, 2017). Other times, more heavy formatting is required, such as in the Astroneer patch notes (Joe, 2017). You will note from these examples that companies vary of style guidelines for the notes the produce. Generally, patch notes should follow this structure:
- Patch Note Title
- Version Number
- Date of Release
- Changes Made
- Developer/Publisher Comments
Note that developer comments are often found throughout the document.
The Content of Patch Notes
All patch notes must contain a list of changes being made to the game. Patch notes may also include such things as known issues (Baior Of Red, 2017), developer comments, notes for a different platform that the game is on (Blizzard Entertainment, 2017), and visual enhancements (Joe, 2017). For most patch notes, the more detailed information, the better. Regardless of the density, readability should be the priority of the document.
With this information, you will continue to do great things in your careers!
References
Baior Of Red. (2017, November 28). Star Citizen Alpha 3.0.0ac PTU.674844 Patch Notes. [Discussion and Feedback]. Message posted to https://robertsspaceindustries.com/ spectrum/community/SC/forum
Blizzard Entertainment. (2017, August 29). OVERWATCH PATCH NOTES – AUGUST 29, 2017. [Patch Notes]. Message posted to https://playoverwatch.com/en-
us/game/patch-notes/pc
Firaxis Games. (2016, December 21). Civilization VI ‘WINTER 2016 UPDATE’ NOW LIVE. Message posted to https://civilization.com/news/entries/civilization-vi-winter-2016-update-now-live/
Joe, System Era. (2017, November 13). “Research Update” – December 18th, 2017.
[Patch Notes]. Message posted to https://forum.systemera.net/topic/44455
research-update-december-18th-2017/
Ubisoft Entertainment. (2018, January 10). OPERATION WHITE NOISE – MID-
SEASON REINFORCEMENTS. [BLOG]. Message posted to https://rainbow6.ubisoft.com/siege/en-us/news/152-317056-16/operation-white
noise-mid-season-reinforcements