Documentation:Digital Glass
| Emerging Media Lab | |
|---|---|
| |
| About EML | |
| A collaborative space for UBC faculty, students and staff for exploration of emerging technologies and development of innovative tools and solutions. This wiki is for public-facing documentation for our projects and procedures. | |
| Subpages | |
Emerging Media Lab Project Documentation Template
Use this template structure when creating documentation for EML projects.
Introduction
What was the problem you were trying to solve? What story do you want to tell?
If you have a case study video, include it here.
FAQ
As the title suggests
First Time Setup Guide
Provide enough information for a first time user to get up and running.
Primary Features....
Provide an overview of the key features of the project and what they do.
Lessons learned
Provide a top level overview of the major challenges encountered and how they were addressed.
Artwork
Provide information on any artwork developed for the project. This could includes scenes, controllers or assets.
Plugins/assets/prebuilds developed
Provide information on any custom components that were developed and how they can be accessed.
Known Issues
Provide information on any know issues affecting functionality or stability.
White Paper
Upload a .pdf version of the project white paper to the wiki and link to it here.
Poster
Upload a printable version of your poster to the wiki and link to it here. An editable version of the document is preferred.
Development Team
Include everyone who worked on the project and their role.
License
|
