DefaultJournalPageStyleGuide - Oliver-Mustoe/Oliver-Mustoe-Tech-Journal GitHub Wiki

This page includes style rules that should generally (BUT DOES NOT HAVE TO BE) followed for tech journals


First should a be a short sentence or two about what the page is/what notes it contains

Notes

Should start from the beginning and work to the ending.

Sentences shouldn't run on too much as to not fill up space and make the page look bad.

OPTIONAL: If the lab has clearly defined section (literally or very easy to impose own), the journal page should contain headers like the following:

Section 1

Anything that references something below should end the line with a colon:

Set sequences of commands or actions should be labeled like below:

  1. 1
  2. 2
  3. 3

Commands should be formatted like this and usually should be on a newline, with a bullet point and a short description preceding or proceeding it like below:

  • command1
    Description of command1.

Description of process, accomplish process with command2 below:

  • command2

NOTE: note should be bold and capitalized like you see on the start of this line .

Commands should also have flags and other processes done documented.


Version Comments Date
v1.1 Editing the need for section headers 9/28/22
v1.0 Initial style guide 9/2/22