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)

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

496: Beauty, Elegance, Consistency

496: Beauty, Elegance, Consistency

Professor Shimon Schocken spoke with us about teaching computer science from NAND logic gates to arithmetic units, micro assembly, virtual machines, compilers, operating systems, and the Tetris games....

6 Maalis 202559min

495: Shortcut the Difficulties of Reality

495: Shortcut the Difficulties of Reality

Professor Cindy Harnett spoke to us about new and different sensors and actuators, primarily designed for soft robotics and fabricated with relatively low cost materials. Cindy is a professor of elect...

21 Helmi 20251h 1min

494: All Tech Is Wearable

494: All Tech Is Wearable

Debra Ansell joined us to talk about finding friends and exchanging neat gifts, accidentally tricking people into making unmanufacutable boards, and happy, blinking lights. Debra is usually known by t...

7 Helmi 20251h 15min

493: Put the Peeps in the Chili Pot

493: Put the Peeps in the Chili Pot

Elecia and Chris talk with each other about the state of Chris' mind, what makes an embedded developer stand out, "LEGO block" based design, unit tests, and astronomy. Whew! Elecia was recently on the...

24 Tammi 20251h 20min

492: Octopus Army

492: Octopus Army

Nathan Jones chatted with us about his proposal for a computer architecture book based on a 4-bit computer. Nathan found the 4-bit computer in the Hackaday SuperCon 2022 badge and was amazed by some...

27 Joulu 20241h 9min

491: Oscillators Oscillating Other Oscillators

491: Oscillators Oscillating Other Oscillators

Chris and Elecia spoke with Kirk Pearson about running audio-electronic-art workshops, interesting sounds, and their book Make: Electronic Music from Scratch: A Beginner's Guide to Homegrown Audio Gi...

13 Joulu 20241h 6min

Suosittua kategoriassa Tiede

tiedekulma-podcast
rss-mita-tulisi-tietaa
rss-poliisin-mieli
utelias-mieli
rss-duodecim-lehti
rss-metsantuntijat-podcast
mielipaivakirja
rss-luontopodi-samuel-glassar-tutkii-luonnon-ihmeita
docemilia
vinkista-vihia
menologeja-tutkimusmatka-vaihdevuosiin
rss-vaasan-yliopiston-podcastit
rss-duokkari-ekstra
rss-astetta-parempi-elama-podcast
rss-tiedetta-vai-tarinaa
rss-lapsuuden-rakentajat-podcast
rss-miljonaarien-tasavalta