Jump to content

General Engineering Tutorials/Best Practice

From Wikiversity

Organize tutorials into a header describing audience, starting point, and replication goal followed by procedure, steps; procedure steps; procedure steps.

Procedures should be named, not numbered. Steps should be numbered with #. This way they can be easily edited, copied and reused.

Directly under procedure should be a horizontal row of pictures (created using gallery) with un-numbered steps in their captions, followed by text descriptions of the steps without referencing the pictures.

Target Audience

[edit | edit source]

Who is suppose to read this: College freshman, in precalc ... never programmed a computer or drawn with 3D software.

Starting Point

[edit | edit source]
  • Google sketchup
  • Raspberry

Replication Goal

[edit | edit source]
  • Simulating section of rube goldberg machine with physics add on to Google Sketchup
  • Installing ROS on debian on pc

Procedure format SD card

[edit | edit source]

row of pictures using the gallery wikimedia syntax.

  1. Step
  2. Step
  3. Step
  4. Step

Procedure cut Electric Guitar Wire

[edit | edit source]

row of picture thumbs linked to youtube video showing how to cut wire

  1. Step
  2. Step
  3. Step
  4. Step