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

Avsnitt(569)

490: Wait Until Physics Has Happened

490: Wait Until Physics Has Happened

Nikolaus Correll spoke with us about robots, teaching robotics, and writing books about robots. Nikolaus is a Professor of Computer Science at the University of Colorado, see his lab website (or his ...

28 Nov 20241h 5min

489: Constructive Cat

489: Constructive Cat

Chris and Elecia discuss her origami art show, ponder PRs for solo developers, attempt to explain GDB debugging, and make a to-do list for getting rid of Kanga. Elecia is having an Origami Octopus Ga...

16 Nov 20241h 1min

488: Two Slices of Complimentary Bread

488: Two Slices of Complimentary Bread

Adrienne Braganza Tacke spoke with us about her book Looks Good To Me: Constructive Code Reviews. It is about how to make code reviews more useful, effective, and congenial. Adrienne's book is availa...

31 Okt 20241h 10min

487: Focus on Fizzing

487: Focus on Fizzing

Chris and Elecia chat about simulated robots, portents in the sky, the futility of making plans, and grad school. A problem with mics led us to delay the show with Shimon Schoken from Nand2Tetris (co...

17 Okt 20241h 5min

486: A Nice Rainbow Dream

486: A Nice Rainbow Dream

Antoine van Gelder spoke to us about making digital musical instruments, USB, and FPGAs. Antoine works for Great Scott Gadgets, specifically on the Cynthion USB protocol analysis tool that can be use...

3 Okt 202454min

485: Conversation Is a Kind of Music

485: Conversation Is a Kind of Music

Alan Blackwell spoke with us about the lurking dangers of large language models, the magical nature of artificial intelligence, and the future of interacting with computers. Alan is the author of Mo...

20 Sep 20241h 17min

484: Collecting My Unhelpful Badge

484: Collecting My Unhelpful Badge

Chris and Elecia talk to each other about setting aside memory in a linker file, printing using your debugger, looking around a new code base, pointers as optimization, choosing processors, skill tree...

5 Sep 20241h 2min

483: An Ion of the Highest Fidelity

483: An Ion of the Highest Fidelity

Rick Altherr spoke with us about high-speed control, complicated systems, and making quantum computers. If you want to know more about building quantum computers, take a listen to Rick's MacroFab epis...

23 Aug 20241h 1min

Populärt inom Vetenskap

dumma-manniskor
p3-dystopia
svd-nyhetsartiklar
allt-du-velat-veta
kapitalet-en-podd-om-ekonomi
rss-vetenskapsradion-2
rss-vetenskapsradion
medicinvetarna
det-morka-psyket
rss-ufo-bortom-rimligt-tvivel-2
bildningspodden
halsorevolutionen
hacka-livet
sexet
rss-geopodden-2
rss-arkeologi-historia-podden-som-graver-i-vart-kulturlandskap
vetenskapsradion
har-vi-akt-till-mars-an
rss-spraket
matfrihet