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)

504: The Robot Was Expecting It

504: The Robot Was Expecting It

It's another episode with Elecia and Chris. This week they discuss people that have influenced their lives and careers, thinking about past career choices and regrets therein, identities, the Embedded...

27 Kesä 20251h 6min

503: The Tiniest Laptops

503: The Tiniest Laptops

Emily Lovell spoke with us about teaching how to contribute to open source, including her own experience creating the LilyTiny as a Master's student and researching the impact as a PhD student. The L...

13 Kesä 20251h 3min

502: Chat, J'ai Peté!

502: Chat, J'ai Peté!

Chris and Elecia talk about Murderbot, LLMs (AI), bikes, control algorithms, and fancy math. The website with the ecology jobs is wildlabs.net from 501: inside the Armpit of Giraffe with Meredith Pa...

3 Kesä 20251h 8min

501: Inside the Armpit of a Giraffe

501: Inside the Armpit of a Giraffe

We spoke with ecologist Dr. Meredith Palmer and embedded engineer Akiba about lions, terror, and technology. Akiba works for FreakLabs.org on global conservation projects. We talked about their Boomb...

15 Touko 20251h 20min

500: Nerding Out About the Ducks

500: Nerding Out About the Ducks

Komathi Sundaram spoke with us about her enthusiasm for tests and test automation. We talked about the different joys of testing vs. development, setting up CI servers, and different kinds of tests in...

2 Touko 20251h 7min

499: This Is Your Problem

499: This Is Your Problem

We spoke with Janet Hansen about the world of professional costumery (with electronics) and becoming an artist. Janet's business is Enlighted where you can find custom illuminated clothing as well as ...

17 Huhti 202550min

498: To Consume Stickers

498: To Consume Stickers

At the end of this week's show, Elecia reads a Winnie the Pooh poem as Cookie Monster death metal. Before that, Chris and Elecia chat about mental health, journaling, personal projects, and listener q...

4 Huhti 20251h 6min

497: Everyone Likes Tiny

497: Everyone Likes Tiny

OpenMV has a new Kickstarter so CEO Kwabena Agyeman chatted with us about more powerful (and smaller!) programmable cameras. See OpenMV's site for their existing cameras. See their (already funded!)...

20 Maalis 20251h 24min

Suosittua kategoriassa Tiede

rss-mita-tulisi-tietaa
rss-poliisin-mieli
tiedekulma-podcast
rss-duodecim-lehti
docemilia
rss-lihavuudesta-podcast
utelias-mieli
radio-antro
rss-sosiopodi
sotataidon-ytimessa
mielipaivakirja
filocast-filosofian-perusteet
rss-laakaripodi
rss-radplus
rss-opeklubi
rss-luontopodi-samuel-glassar-tutkii-luonnon-ihmeita