Project Documentation - Alien World
The enirety of your frontend repository can capture the history of your project.
Introduction
There are many key parts to managing and finishing a project.
-
README.md. This contains information to help someone get started with the project. The alienWorld repository was built from NightHawk pages, so much of the README already contained many development guidelines.
-
Project Plan. This contains a project plan and guide. This contains plan for the project and overviews the key elements of code.
-
Issue Management. Issues help drive the work of the project. Open issues are assigned to individuals. Closed issues contain history of work that has been completed.
-
GitHub Pages Blog. A big advantage of GitHub Pages as a frontend is that allows for classic frontend runtime and blogging to be contained in one place. In education, a huge part of our project is how it was made, and how we collaborated, and how we progressed through steps.
-
GitHub Pages History/Time Box. Managing meetings and capturing history tell a big story for a team. Time Boxing history is a great way to share key elements of project.
-
Anatomy of Alien World. This contains key thinking that went into designing code. This was build in same document as Project Plan.
-
Code Comments. Almost everyone, including Teachers, do not remeber how code works withou comments. Be sure to comment key code block and algorithms.