Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save frankolson/d2ed619fd1f0e7f69eb0ed437f198c97 to your computer and use it in GitHub Desktop.
Save frankolson/d2ed619fd1f0e7f69eb0ed437f198c97 to your computer and use it in GitHub Desktop.
Markdown version of Unity Learn's project design document: https://learn.unity.com/tutorial/lab-1-personal-project-plan

Project Design Document: Golf Range Simulator

  • Created at: mm/dd/yyyy
  • Author: Name

Project Concept

1. Player Control

You control a [PLAYER TYPE] in this [TOP DOWN / SIDE VIEW / ISOMETRIC] game where [USER INPUT TYPE] makes the player [DESCRIPTION OF PLAYER MOVEMENT].

2. Basic Gameplay

During the game, [TYPES OF OBJECTS] appear from [AREA(S) OF THE SCREEN] and the goal of the game is to [GOAL OF THE GAME].

3. Sounds & Effects

There will be sound effects [DESCRIPTION OF SOUND EFFECTS] and particle effects [DESCRIPTION OF PARTICLE EFFECTS]. (optional) There will also be [DESCRIPTION OF ANY OTHER EXPECTED SPECIAL EFFECTS OF ANIMATION IN THE PROJECT].

4. Gameplay Mechanics

As the game progresses, [DESCRIPTION OF GAMEPLAY MECHANIC], making it [EFFECT OF GAMEPLAY MECHANIC]. (optional) There will also be [DESCRIPTION OF ANY OTHER GAMEPLAY MECHANIC(S) AND THEIR EFFECT ON THE GAME].

5. User Interface

The [SCORE / LIVES / TIMER] will [INCREASE / DECREASE] whenever [CONDITION TO CHANGE SCORE / LIVES / TIMER]. At the start of the game, the title [WORKING TITLE] will appear and the game will end when [CONDITION TO END THE GAME].

6. Other Features

[ANY OTHER NOTES ABOUT THE PROJECT THAT YOU DON'T FEEL WERE ADDRESSED IN THE ABOVE.]

Project Timeline

Milestone #1

Due: mm/dd

Description:

  • Functional feature(s) by milestone #1

Milestone #2

Due: mm/dd

Description:

  • Functional feature(s) by milestone #2

Milestone #3

Due: mm/dd

Description:

  • Functional feature(s) by milestone #3

Milestone #4

Due: mm/dd

Description:

  • Functional feature(s) by milestone #4

Milestone #5

Due: mm/dd

Description:

  • Functional feature(s) by milestone #5

Backlog

Due: mm/dd

Description:

  • Feature on backlog - not a part of the minimum viable product
  • Feature on backlog - not a part of the minimum viable product
  • Feature on backlog - not a part of the minimum viable product

Project Sketch

Project sketch

@luisartg
Copy link

Hi! I liked very much this markdown version, since it can be saved along the project and tracked with version control. I made a fork of the document and made changes for organization and readability using tables. Pull request are not available for Gist, but you can copy from my fork directly if you liked the new format. It would be great to keep working on the document and see what else can we improve. Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment