Documentation_BMPs

• Figures and Table Descriptions
  • Make sure that your axis are labelled with units. always.
  • The table description should tell you all that you need to know. You should be able to snapshot the table and share in an email, social media, what-have-you, and it will make clear sense to someone else. Instead of a person seeing your image and thinking "I will need to read their paper to figure out what this is saying" the goal is to have them thing "I really, really want to read their paper because they have interesting things to say!".
• Write Equations.
  • Writing equations is the clearest and concisest possible way to demonstrate engineering and analysis concepts to your scientific peers.
  • Using LateX in Github Issues! https://github.blog/changelog/2022-05-19-render-mathematical-expressions-in-markdown/