Click here to Skip to main content
15,904,153 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: 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 
> I have written a bit of Code to talk to bit of hardware.

Does the hardware in question has a datasheet?
If hard to find, provide link or better the actual PDF you used to write the code.

Some example applications are often more useful than documentation in practice.
At least a minimalistic "hello world" app to get started, maybe a performance testing one.
The more complex the hardware the more example apps might be needed.

What is also useful is adding some (minimal) debugging.
E.g. an I2C based class should contain something like bool isConnected().
A SPI based class should have means to set the clock speed.
This allows 1st order testing for users of your code.

my 2 cents
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 
GeneralRe: Silly Documentation Question Pin
jochance18-Apr-24 5:58
jochance18-Apr-24 5:58 
GeneralRe: Silly Documentation Question Pin
charlieg18-Apr-24 17:17
charlieg18-Apr-24 17:17 
GeneralWhat sort of performance should I expect? Pin
dandy7216-Apr-24 5:03
dandy7216-Apr-24 5:03 
GeneralRe: What sort of performance should I expect? Pin
PIEBALDconsult16-Apr-24 5:35
mvePIEBALDconsult16-Apr-24 5:35 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 5:46
dandy7216-Apr-24 5:46 
GeneralRe: What sort of performance should I expect? Pin
jochance17-Apr-24 8:01
jochance17-Apr-24 8:01 
GeneralRe: What sort of performance should I expect? Pin
k505416-Apr-24 6:04
mvek505416-Apr-24 6:04 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 7:00
dandy7216-Apr-24 7:00 
GeneralRe: What sort of performance should I expect? Pin
k505416-Apr-24 7:10
mvek505416-Apr-24 7:10 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 7:37
dandy7216-Apr-24 7:37 
GeneralRe: What sort of performance should I expect? Pin
theoldfool16-Apr-24 6:54
professionaltheoldfool16-Apr-24 6:54 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 7:09
dandy7216-Apr-24 7:09 
GeneralRe: What sort of performance should I expect? Pin
theoldfool16-Apr-24 7:32
professionaltheoldfool16-Apr-24 7:32 
GeneralRe: What sort of performance should I expect? Pin
dandy7216-Apr-24 7:48
dandy7216-Apr-24 7:48 
AnswerRe: What sort of performance should I expect? Pin
Clumpco16-Apr-24 21:14
Clumpco16-Apr-24 21:14 

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.