Versions Compared

Key

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

Year-leading-up

...

with the technical report in mind. No decison should be left without motivation and no requirement should be left unverified. Typically, designs change at least a little bit as the team begins testing, so the report can’t be fully done in advance. However, you can include specific things well in advance:

...

  • Write up tables of basic data (lengths, weights, battery capacities, sensor rates, etc.)

  • Write (can be brief) test descriptions and reports

  • Write your subsystem’s part of the flight risk assessment

Writing guidance

According to ESRA, this is how you should write a report:

View file
nameESRA Technical Report Writing.pdf

Section layout

Organize your text so that at every point, every decision made has motivation.

...

The template provides examples for all of these items under examples.tex ~ if that is too much effort, “how to do X in LaTeX” is usually well-answered by an Overleaf article.

Remember: If you find yourself numbering, referencing, or formatting manually, you’re doing it wrong!

Common LaTeX goofs

  • Whitespace and paragraph breaks: LaTeX does not count single new-lines (<Enter>) as paragraph breaks; it just treats them like spaces. Multiple consecutive spaces or tabs are also just treated as one space. To create wider spaces, use operators like \,, \>, or \quad. To create a newline without a pragraph break, use\\. To create a paragraph break, leave a blank line in the source between the paragraphs or use the \par operator.

  • Special characters: & is a special character for field separation in tables, and % is the comment chartacter. To use either of these, escape them with \, so that \& prints a “&” into the text, and \% prints a “%” into the text.

...

  1. Using Launch’s Overleaf account, copy the template and rename to the current year

  2. Copy and save editing and viewing links

  3. Immediately log out of Launch’s Overleaf account and into your own

  4. Populate the basic information (number, year, authors, …)

...