Click here to Skip to main content
15,900,724 members

Welcome to the Lounge

   

For discussing anything related to a software developer's life but is not for programming questions. Got a programming question?

The Lounge is rated Safe For Work. If you're about to post something inappropriate for a shared office environment, then don't post it. No ads, no abuse, and no programming questions. Trolling, (political, climate, religious or whatever) will result in your account being removed.

 
GeneralRe: These mice were supposed to outlast me... Pin
charlieg21-Apr-24 3:13
charlieg21-Apr-24 3:13 
GeneralRe: These mice were supposed to outlast me... Pin
dandy7222-Apr-24 5:44
dandy7222-Apr-24 5:44 
GeneralRe: These mice were supposed to outlast me... Pin
stheller213-May-24 18:58
stheller213-May-24 18:58 
GeneralSilly Documentation Question Pin
glennPattonWork316-Apr-24 6:11
professionalglennPattonWork316-Apr-24 6:11 
GeneralRe: Silly Documentation Question Pin
honey the codewitch16-Apr-24 6:17
mvahoney the codewitch16-Apr-24 6:17 
GeneralRe: Silly Documentation Question Pin
charlieg18-Apr-24 17:07
charlieg18-Apr-24 17:07 
GeneralRe: Silly Documentation Question Pin
honey the codewitch18-Apr-24 18:16
mvahoney the codewitch18-Apr-24 18:16 
GeneralRe: Silly Documentation Question Pin
Marc Clifton16-Apr-24 7:06
mvaMarc Clifton16-Apr-24 7:06 
Well, there's the high level stuff:

1. What does the hardware do, and why?
2. What are the requirements for the code?

Mid-level stuff:

1. How to integrate the code into a project
2. How to test the code and hardware

Low-level stuff:

1. What are the "public" methods to initialize the code & hardware
2. What are the "public" methods to interact with the hardware -- read/write/reset/diagnostics, etc
3. What is a typical use-case scenario
4. What are the best practices for initialization and shutdown of the code/hardware?
5. What parts of the code are thread-safe, what parts are not? (I would assume none of it is thread safe, but who knows.)

Nano-level stuff:

1. Describe the low-level interface between the code and the hardware.
2. Describe signals and timing (or include the specs on the hardware)
3. Describe specific constraints on the code, like, are there timing dependencies
4. Describe interrupts the code uses when interacting with the hardware

My 2c of some ideas, dredging up memories of documentation I've written in the past for software-hardware stuff Wink | ;)

GeneralRe: Silly Documentation Question Pin
Amarnath S16-Apr-24 7:13
professionalAmarnath S16-Apr-24 7:13 
GeneralRe: Silly Documentation Question Pin
glennPattonWork316-Apr-24 21:55
professionalglennPattonWork316-Apr-24 21:55 
GeneralRe: Silly Documentation Question Pin
Salvatore Terress17-Apr-24 2:16
Salvatore Terress17-Apr-24 2:16 
GeneralRe: Silly Documentation Question Pin
Mike Hankey16-Apr-24 7:29
mveMike Hankey16-Apr-24 7:29 
GeneralRe: Silly Documentation Question Pin
Gary Wheeler17-Apr-24 1:02
Gary Wheeler17-Apr-24 1:02 
GeneralRe: Silly Documentation Question Pin
Mike Hankey17-Apr-24 1:24
mveMike Hankey17-Apr-24 1:24 
GeneralRe: Silly Documentation Question Pin
Gary Wheeler17-Apr-24 1:33
Gary Wheeler17-Apr-24 1:33 
GeneralRe: Silly Documentation Question Pin
Mike Hankey17-Apr-24 1:37
mveMike Hankey17-Apr-24 1:37 
GeneralRe: Silly Documentation Question Pin
trønderen17-Apr-24 6:43
trønderen17-Apr-24 6:43 
GeneralRe: Silly Documentation Question Pin
Mike Hankey17-Apr-24 6:47
mveMike Hankey17-Apr-24 6:47 
GeneralRe: Silly Documentation Question Pin
trønderen17-Apr-24 8:51
trønderen17-Apr-24 8:51 
GeneralRe: Silly Documentation Question Pin
Mike Hankey17-Apr-24 9:18
mveMike Hankey17-Apr-24 9:18 
GeneralRe: Silly Documentation Question Pin
charlieg18-Apr-24 17:05
charlieg18-Apr-24 17:05 
GeneralRe: Silly Documentation Question Pin
charlieg18-Apr-24 17:26
charlieg18-Apr-24 17:26 
GeneralRe: Silly Documentation Question Pin
rob tillaart16-Apr-24 20:50
rob tillaart16-Apr-24 20:50 
GeneralRe: Silly Documentation Question Pin
glennPattonWork316-Apr-24 21:54
professionalglennPattonWork316-Apr-24 21:54 
GeneralRe: Silly Documentation Question Pin
Nelson Goncalves Oct202217-Apr-24 2:17
Nelson Goncalves Oct202217-Apr-24 2:17 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.


Straw Poll

Were you affected by the geomagnetic storms this past weekend?
Communication disruptions, electrified pipes, random unexplained blue-screens in Windows - the list of effects is terrifying.
  Results   494 votes