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)

472: Field of Boxes

472: Field of Boxes

Making Embedded Systems, 2nd Edition came out today! Chris and Elecia talk about the changes, the writing, but not the eldritch horror. Then we talk about pianos and origami. The electronic version i...

7 Maalis 20241h 2min

471: Bicycle Built For Two

471: Bicycle Built For Two

Where electronics meets music, there is a board called Daisy. Created by ElectroSmith, Andrew Ikenberry, the goal of the board is to teach computers to sing. Andrew joined us to talk about music, audi...

22 Helmi 202458min

470: Upping the Chaos Level

470: Upping the Chaos Level

Helen Leigh joined us to talk about putting together conferences (including Teardown 2024), indie hardware producers (including via Crowd Supply), and building communities. Teardown will be June 21-23...

9 Helmi 20241h 16min

469: Saving the World Is Not a Hobby

469: Saving the World Is Not a Hobby

Chris and Elecia chat with each other about motor encoder reading methods, conferences coming up, soldering irons, schematic reviews, looking for a new job, and general life. Some conferences coming ...

28 Tammi 20241h 4min

468: Designed to Kill All Humans

468: Designed to Kill All Humans

Anders Nielsen joined us to talk about why the 6502 is the best processor. Anders also sells 65uino kits on his store: imania.dk. For more explanation of what they are, how they work, attaching perip...

12 Tammi 202456min

467: Temporary Axolotl

467: Temporary Axolotl

Chris and Elecia talk about cars, fleeting moments of fame, their year, and the sorry state of tools in the embedded space. Chris became internet famous for asking a car dealership's chatbot (powered ...

29 Joulu 202352min

466: Attacked by a Goose on the Way to the Office

466: Attacked by a Goose on the Way to the Office

Ralph Hempel spoke with us about the development of Lego Mindstorms from hacking the initial interface to running Debian Linux as well as programming Mindstorms in Python. Happy 25th birthday to Lego ...

14 Joulu 20231h 8min

465: Dinosaurs, Pirates, Spaceships

465: Dinosaurs, Pirates, Spaceships

Yanina Bellini Saibene joined us to discuss teaching, localization, barriers to learning coding, and global communities. Yani works on Teach Tech Together (https://teachtogether.tech/) with Greg Wils...

1 Joulu 20231h 5min

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