288: You Got a Screen!
Embedded10 Touko 2019

288: You Got a Screen!

Christopher (@stoneymonster) and Elecia (@logicalelegance) discuss embedded systems education and project documentation.

Elecia wrote about her love of notebooks on the https://www.embedded.fm/blog-index.

yEd, for when you don't have Visio. Asciiflow.com, for when you don't have yEd (or you want to put diagrams in your comments)

We talked about many different documents and tried to note design vs implementation, product vs engineering vs user, and why we wanted them. We didn't mention mechanical things because, ya know, software engineers. Some documentation we mentioned:

  • Product documentation

  • Schematics with block diagrams and comments. Also a GPIO to function spreadsheet.

  • UI flow when the system has a screens (Balsamiq for wireframe testing UIs)

  • SW spec and design doc: what do we plan to build and what are the tricky parts

  • SW configuration and SW developer docs: how to rebuild the computer that can build the code from scratch, also notes on debugging methodology

  • User manual: Usually not written by SW but may need SW's patient input

  • Code comments: Functions and files get 5Ws: who, what, why, when, where, and how.

    • Who should call this?

    • What will its effect be? ("What will it do" but not in line by line detail!)

    • How does it work?

    • Why does it work this way?

    • When should it be called?

    • Where are its parameters? ("What" works here too but "where" is nice to remind you to check your memory assumptions.)

  • Repository checkin comments

  • Style guide (Such as Google's or PEP)

  • Manufacturing docs and tests docs

Adafruit and Sparkfun both write good documentation, writing to users about how to use their code. Elecia likes Adafruit's sensor library as a good set of code to review (including how much is in their docs vs their code).

Jaksot(569)

450: Swimming Through Nutritious Slurry

450: Swimming Through Nutritious Slurry

Kari Love joined us to talk about soft robotics, robots in religion, and squishiness. Kari co-authored Soft Robotics: A DIY Introduction to Squishy, Stretchy, and Flexible Robots. Her website is kari...

25 Touko 20231h 6min

449: Soldering the Ukulele

449: Soldering the Ukulele

Chris and Elecia talk about internetting your thing, motivating yourself with cheese, a pile of scrabble letters, an electric ouija board, and a supervillain origin story. Elecia will be on a Memfault...

11 Touko 20231h 1min

448: Little Squiggles All Around

448: Little Squiggles All Around

Carl Bugeja makes actuators out of PCBs, puts them to work flapping origami bird wings (or moving robot rovers), and takes videos of the whole process. Oh, and get this, self-soldering circuits. Firs...

27 Huhti 20231h 1min

447: All Sorts of Weird Problems

447: All Sorts of Weird Problems

We spoke with Chris Gammell about IoT, podcasting, relaxing, and learning. Chris works at Golioth.io. They have a neat blog that talks about reference designs, Zephyr RTOS, and making products. We tal...

13 Huhti 20231h 5min

446: World's Best PB&J

446: World's Best PB&J

Chris and Elecia talk about ChatGPT, conferences, online compilers, and Ardupilot. Compiler Explorer: godbolt.org (and function pointer example) Jupyter Notebooks with colab: colab.research.google.com...

30 Maalis 202354min

445: I Do Not Like Blinking

445: I Do Not Like Blinking

We spoke with Charlyn Gonda about making things glow, dealing with imposter syndrome, and using origami. Charlyn's website is charlyn.codes, the projects we talked about are documented there. You can ...

16 Maalis 20231h 11min

444: It Is If You Do It Wrong

444: It Is If You Do It Wrong

Peter Griffin spoke with us about operant boxes, juggling many projects, getting into embedded systems, and bottle rockets. When we talked about 3D printing, Peter mentioned the Maker Muse Clearance...

3 Maalis 202357min

443: Vexing Machines

443: Vexing Machines

Chris and Elecia talk about photons, comets, patterns, other flying objects, and cameras. Chris uses PixInsight for processing and has an Ioptron Sky Tracker. Apologies to our southern hemisphere lis...

17 Helmi 20231h

Suosittua kategoriassa Tiede

tiedekulma-podcast
rss-mita-tulisi-tietaa
mielipaivakirja
rss-duodecim-lehti
rss-poliisin-mieli
utelias-mieli
radio-antro
docemilia
menologeja-tutkimusmatka-vaihdevuosiin
rss-metsa
rss-ylistys-elaimille
rss-sosiopodi