Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Comments on the importance of documentation:

  • In the wise words of my mentor (note I have terribly paraphrased him): "I have rarely seen a successful team with a lack of documentation, and even more rarely seen an unsuccessful team with good documentation." 
  • Good documentation makes it easy to show a potential employer / sponsor the quality of our / your work. If your documentation is well organized, it will be easier to retrieve when making your portfolio, and will give you good practical experience for a real job.
  • It is universally understood that documentation is not the attractive part of engineering, but proper documentation allows for the team to progress.

 

A fundamental part of a successful project, as well as usefulness of the project for future teammates, is proper documentation.

This shows us:

...

This project is a template for what all Launch Initiative projects should encompass. A description of each document and the document's purpose is listed on each page.

NOTE: 'Project' should be replaced by the actual project name for all pages as Confluence does not allow redundant page names.

Example: 'Project' Overview = VEGA Overview

Detailed Instructions for copying this template can be found here.

NOTE: This page will be the highest level of the project (the project name will be title of this page). This page will have a "Children Display" of sub-sheets.

BELOW THIS LINE SHOULD BE PART OF THE PROJECT PAGE:

Team Members:

Project Mission:

The project mission states goals for the project. Should be in paragraph form (not a numbered or bulleted list).Team Members:


Project Mission:

Prometheus' mission is to create an L2 class rocket, equipped with 360 degree cameras to capture stellar footage of the launch, ascent, descent, and recovery processes that high powered rockets endure.


Expected Timeline (or Completion Date):

Fully assembled and flight tested rocket expected by end of Spring 2021 semester.

Project Pages:

Child pages (Children Display)

...