gergelytakacs/AutomationShield

AutomationShield Wiki, YouTube Style Guide

gergelytakacs opened this issue · 0 comments

gergelytakacs commented

This issue details the style guide and practices for writing the AutomationShield Wiki. The current best practices are seen in the HeatShield Wiki.

Wiki Pages

General guidelines

  • English only.
  • Do not host images or files outside the Wiki (or the repository).
  • Please push images and files to the Wiki repository through Git and use the existing folder structure to keep order.

Necessary elements of a hardware wiki

Downloads

  • Include a download for the production-ready PCB (Gerber format) files in a ZIP container.
  • Include a download for the editable PCB-design file (DIP Trace).
  • Include a download for the editable schematic-design file (DIP Trace).
  • If there is a 3D assembly of the device, include it in a downloadable format.
  • If there are 3D printed components, include these in a universally accessible format.

Images and illustrations

  • Include at least one top view and isometric view of the hardware.
  • The photos must be color and distortion corrected, with the background cut-out. (e.g. catalogue-like images).
  • If you have a 3D illustration, include renders of the device.
  • Include the schematic view from DIP Trace
  • Include the PCB of the device: top and bottom
  • Screenshots, Simulink schemes, and line drawings (e.g. CAD) must be saved and included in the PNG format.
  • Include a screenshot of the process in the Arduino IDE. Use a relatively small (not full-screen) window, so that the line widths and annotations are still visible. Leave the window elements intact. Use the PNG format. Aim to achieve a 4:3 side for the window. This is a representative of a good screenshot:
    image

Table of components

  • The table must include a short description of the item (e.g. MOSFET), a long description (BUZ11, N-channel power MOSFET, 50V, TO-220 THT), designation on the PCB (Q1) a quantity needed (1), a unit price and a total price.

Tips and hints

  • Tables will not be rendered, unless you insert a new empty line between the text and the first row of the table.

Videography

General guidelines

  • English only (captions, text, voiceover)
  • Video editing: DaVinci Resolve. Use the 16.0 version of DaVinci Resolve which can be found for Win, Mac and Linux for free here.
  • Screen grab OBS Studio. You can download it here.
  • Resolution Use HD resolution (1920×1080), nothing less nothing more. 4 k at the moment is just too much, however HD is expected.
  • **Framerate use 24 FPS. We do not own professional cameras etc. and 24 FPS is to be expected from everything. So it is good enough.
  • Maximal time for "intro" 5 s, otherwise viewers lose interest (backed up by hard evidence). Intro includes AutomationShield generic logo and some sort of title slide too
  • No tacky and flashy effects, keep it simple.

OSB Studio

  • You will need a fairly good computer, the process is surprisingly hard on the machine.
  • If you can use dual-screens so you see OSB Studio while you work with the target window.
  • When you set it up, optimize for recording not streaming. Choose 30 FPS not 60. This is still not good enough, you will need to change the framerate to 24, this way you maximize resources.
  • Go to File>Settings>Video and set the Base (canvas) and Output (file) resolution to 960 x 640 pixels, as the grab will be used as overlay anyways, you do not need full resolution and the grabbing process is CPU intensive,
  • Go to Sources, click + and find Window Capture. Un-check Capture Cursor so the cursor is not to be seen.
  • Go to File>Settings>Hotkeys and set a key combination that you will you to start and stop recording. You can try something like Ctrl+Alt+R, just click into the field and push the key combo you picked.
  • Adjust the bounding box on the canvas to e.g. top left than resize your window to match the canvas size as close as possible. You see this by the changing red (bounding box) rectangle in relation to the background (black).
  • If you wish to export only one window, click on the bounding box, left click and select Resize output (source size) to get a 1:1 export of the pixels. This will change the outptut size to something other than your setting, but the result will not be resampled.
  • Remember you may add more windows and elements to a canvas, even a Webcam.

DaVinci Resolve

  • Beginner's tutorial here. Includes information on how to do picture-in-picture, keyframes and add text.