luisartg/unity-project-design-document-template.md

## unity-project-design-document-template.md

      
    Raw
  

              unity-project-design-document-template.md
            
          
    Project Design Document: [Project Name]


Created at: mm/dd/yyyy
Author: Name

Project Concept

Summary

Describe here a little bit of your project main idea.
1. Player Control

Table of Symbols


Symbol
Meaning


Example 1: [A-Z]
Key letter, multiple letters are divided by commas (,)


Example 2: [MBL]
Mouse Button Left click


Example 3: [MBR]
Mouse Button Right click


You control a [PLAYER TYPE] in this [TOP DOWN / SIDE VIEW / ISOMETRIC] game where:


User Input
Makes the player


Example: B Button
Jump


2. Basic Gameplay

During the game:


Object type
Action type
Condition


Example: Enemy_Monster01
Jumps from a tree to attack the player
When player gets near the tree


Game Goal

The goal of the game is to [GOAL OF THE GAME].
Tip: If there are multiple goals, you can list them as:

Goal A
Goal B

3. Sounds & Effects


Sound
Played when


Example: DirtStepSound
when player walks on ground


Particle Effect
Played when


Example: DirtParticle
when player walks on ground


Animation
Played when


Example: WalkAnimation
when player walks on ground


4. Gameplay Mechanics

As the game progresses:


Description of gameplay mechanic
Effect on the game


Example: Everytime a minute pass
the enemy counter will increase 1 for the enemy spawner


5. User Interface


Interface element
Action
On Condition


Example: Score
Increase
when player destroys an enemy


Example: Score
Decrease
when player destroys a package


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
Due date
Description


#1
mm/dd
Functional feature(s) by milestone #1


#2
mm/dd
Feature 1
Feature 2
Feature 3
For milestone #2


#3
mm/dd
- Feature 1 
 - Feature 2 
 - Feature 3 
 For milestone #3


Backlog


Feature/Task
Due date


Feature on backlog #1 - not a part of the minimum viable product
mm/dd


Feature on backlog #2 - not a part of the minimum viable product
mm/dd


Feature on backlog #3 - not a part of the minimum viable product
mm/dd


Project Sketch
Symbol	Meaning
Example 1: [A-Z]	Key letter, multiple letters are divided by commas (,)
Example 2: [MBL]	Mouse Button Left click
Example 3: [MBR]	Mouse Button Right click
Interface element	Action	On Condition
Example: Score	Increase	when player destroys an enemy
Example: Score	Decrease	when player destroys a package
Milestone	Due date	Description
#1	mm/dd	Functional feature(s) by milestone #1
#2	mm/dd	Feature 1 Feature 2 Feature 3 For milestone #2
#3	mm/dd	- Feature 1 - Feature 2 - Feature 3 For milestone #3
Feature/Task	Due date
Feature on backlog #1 - not a part of the minimum viable product	mm/dd
Feature on backlog #2 - not a part of the minimum viable product	mm/dd
Feature on backlog #3 - not a part of the minimum viable product	mm/dd