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(567)

456: Left Right Symmetry of a Banana

456: Left Right Symmetry of a Banana

Damien George spoke with us about developing with and for MicroPython while Elecia tries not to spill all the secrets about her client. To start at the beginning, you probably want to check out microp...

3 Elo 20231h 8min

455: Snaps!

455: Snaps!

Natalie Friedman joins us to discuss when, where, how, and why robots should wear clothing. Natalie is a PhD candidate at Cornell Tech. Natalie's website is natalie-friedman.com and you can find her ...

20 Heinä 202355min

454: Printf Hello

454: Printf Hello

Uri Shaked surprises us with a chat about silicon design when we were expecting to talk about a web-based board simulator. If you want to try your hand at silicon design, check out Tiny Tapeout, a wa...

6 Heinä 20231h 15min

453: Too Dumb to Quit

453: Too Dumb to Quit

Nathan Jones has been talking about building command line interfaces, good design practices in C, creating MCU boards, wielding the PIC of destiny, and going beyond Arduino. As we are too lazy to atte...

22 Kesä 20231h 8min

452: Numbers on Computers Are Weird

452: Numbers on Computers Are Weird

Julia Evans spoke with us about how computers compute. We discussed number representation including floating point as well as Julia's extensive collection of 'zines and comics. Julia's zines about deb...

15 Kesä 20231h 11min

451: From Concept to Launch

451: From Concept to Launch

Phillip Johnston of Embedded Artistry, Tyler Hoffman of Memfault, and Elecia White discuss the software tasks that tend to fall through the cracks after the device has all its features but before it i...

8 Kesä 20231h 2min

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

Suosittua kategoriassa Tiede

tiedekulma-podcast
rss-mita-tulisi-tietaa
rss-poliisin-mieli
docemilia
rss-duodecim-lehti
utelias-mieli
radio-antro
filocast-filosofian-perusteet
rss-laakaripodi
rss-sosiopodi
ihanat-ipanat
sotataidon-ytimessa
mielipaivakirja
rss-bios-podcast
rss-radplus
rss-opeklubi
rss-lihavuudesta-podcast