288: You Got a Screen!
Embedded10 Mai 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).

Episoder(569)

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 Des 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 Des 20231h 5min

464: Please Make This Monster Look Scary

464: Please Make This Monster Look Scary

Chris and Elecia talk about their favorite processors, their breakfast preferences, large language model ethics, presents, and Eeyore's birthday. Elecia's new edition of her book Making Embedded Sys...

16 Nov 202359min

463: Layers of Band-Aids

463: Layers of Band-Aids

Kevin Lannen is an embedded systems engineer making powered wheelchairs safer. This sounded interesting to us. Kevin works at LUCI Mobility (luci.com). Check out their tear jerker introduction video a...

2 Nov 202356min

462: Spontaneously High Performing

462: Spontaneously High Performing

Marian Petre spoke to us about her research on how to make software developers better at developing software. Marian is an Emeritus Professor of the School of Computing & Communications at the Open Un...

19 Okt 20231h 15min

461: Am I the Cow in This Scenario?

461: Am I the Cow in This Scenario?

Chris and Elecia discuss the pros and cons of completing one project or starting a dozen. Elecia's 2nd edition of Making Embedded Systems is coming out in March. (Preview is on O'Reilly's Learning S...

5 Okt 202358min

460: I Don't Care What Your Math Says

460: I Don't Care What Your Math Says

Author, engineer, manager, and professor, Dr. Greg Wilson joined Elecia to talk about teaching, science in computer science, ethics, and policy. The request for curriculum that started the conversatio...

28 Sep 20231h 19min

459: Ideas Have to Come From Somewhere

459: Ideas Have to Come From Somewhere

Professor AnnMarie Thomas spoke with us about playful learning through joy, whimsy, surprise, and meeting new people. We also spoke with AnnMarie about how adults can foster an environment that enco...

14 Sep 20231h 17min

Populært innen Vitenskap

fastlegen
tingenes-tilstand
rekommandert
forskningno
rss-nysgjerrige-norge
sinnsyn
rss-rekommandert
vett-og-vitenskap-med-gaute-einevoll
smart-forklart
pod-britannia
fjellsportpodden
liberal-halvtime
jss
villmarksliv
nevropodden
aldring-og-helse-podden
rss-overskuddsliv
psykopoden
tomprat-med-gunnar-tjomlid
dekodet-2