Author Topic: What Ever Happened to Well Documented User Manuals  (Read 3062 times)

0 Members and 1 Guest are viewing this topic.

Offline rsjsouza

  • Super Contributor
  • ***
  • Posts: 6106
  • Country: us
  • Eternally curious
    • Vbe - vídeo blog eletrônico
Re: What Ever Happened to Well Documented User Manuals
« Reply #25 on: October 02, 2023, 06:47:12 pm »
I used to write technical manuals and application notes for our SW products, as well as the online help guide.

An infinitesimal fraction of people actually took the time to read them, while others missed important details explicitly shown on page 2 of the manual. 

After all that, we figured the manuals were much more important to the technical support than to the general public - after all, an answer could be found quite quickly, despite the occasional idio... *ahem* "belligerent customer" that "you shouldn't expect me to read the whole manual" when it was pointed to them the page, section and sometimes the paragraph where the information was present.

This comes as no surprise in general, since even the host of this website prides himself in never reading them...  :box:
Vbe - vídeo blog eletrônico http://videos.vbeletronico.com

Oh, the "whys" of the datasheets... The information is there not to be an axiomatic truth, but instead each speck of data must be slowly inhaled while carefully performing a deep search inside oneself to find the true metaphysical sense...
 

Offline JPortici

  • Super Contributor
  • ***
  • Posts: 3573
  • Country: it
Re: What Ever Happened to Well Documented User Manuals
« Reply #26 on: October 02, 2023, 07:07:10 pm »
lots of warnings & compliance logos
this is required/mandated
Quote
the heart of the user manual
this is not
Quote
is missing
and now you know why.

My mother taught me how to write user manuals, she had to do it for her peers and taught me to (try to) do things as self explanatory as possible. I sometimes write manuals and procedure guides for my colleagues, but i just don't bother anymore, it's a waste of time. People on the internet prefer to ask something that they could just google, because they are too lazy to even do that prefer to interact with a human


these are the days in which you are proclamed a professor/know it all/asshole/all the above for having the nerve to suggest people to read the documentation
« Last Edit: October 02, 2023, 07:08:47 pm by JPortici »
 

Offline BeBuLamar

  • Super Contributor
  • ***
  • Posts: 1421
  • Country: us
Re: What Ever Happened to Well Documented User Manuals
« Reply #27 on: October 02, 2023, 08:07:13 pm »
Money is the reason but if most people would read the manuals and appreciate the manuals then they will provide good manuals. Manufacturers only spend money on things that their customers perceive as value. To many people the manuals have no value and thus to the manufacturers it's not worth it to spend money producing them.
 

Online SiliconWizard

  • Super Contributor
  • ***
  • Posts: 15800
  • Country: fr
Re: What Ever Happened to Well Documented User Manuals
« Reply #28 on: October 02, 2023, 10:15:25 pm »
Money is the reason but if most people would read the manuals and appreciate the manuals then they will provide good manuals. Manufacturers only spend money on things that their customers perceive as value. To many people the manuals have no value and thus to the manufacturers it's not worth it to spend money producing them.

Yes but you are summing up the entirety of modern business here. It's not just about manuals, it's the same principle for absolutely everything.
What I'm not completely convinced about anymore is the recurring narrative about how customers drive the offering of businesses through the perceived value.

While this is part of the equation for sure, the other part is the converse. Businesses drive the perceived value of customers via various marketing tricks, sometimes (and these days, more often than not) using regulations as a pretext (for instance: we'll stop providing paper manuals because it's so bad for the planet - for a while, you'll get the same manuals on CD or USB keys, and then manuals just go out of fashion gradually.)

There's also the related, group effect, where the majority of businesses in a given market make the same kind of decisions because they sound trendy and, rather quickly, customers have no choice anymore (nowhere else to turn to), so a given demand disappears for lack of offer. "Demand and offer" is an intricate feedback loop and certainly not a one-way street only as we still hear way too often .
« Last Edit: October 02, 2023, 10:17:01 pm by SiliconWizard »
 

Offline Berni

  • Super Contributor
  • ***
  • Posts: 5050
  • Country: si
Re: What Ever Happened to Well Documented User Manuals
« Reply #29 on: October 03, 2023, 05:34:39 am »
User guides are done by a publicity department that probably don't know what function the unit does anyway, the writer has probably never used one and just got a description of the various controls. The safety warnings are to CYA for the company - I mean draw attention to known hazards and providing the suitable mitigations to these hazards.

I am an engineer and I have written service manuals, but I got the first one I wrote sent back as it was too detailed and potentially revealed company IPO

Yep that is ridiculous when 50 years ago manuals often had full schematics of the product so that it could be fixed more easily.
 

Offline armandine2

  • Frequent Contributor
  • **
  • Posts: 750
  • Country: gb
Re: What Ever Happened to Well Documented User Manuals
« Reply #30 on: October 03, 2023, 09:03:00 am »
https://kitronik.co.uk/products/inventors-kit-for-arduino

the 51 page tutorial book that comes with Kitronik's Inventor's Kit is noticeably well made -  a bit vague with the IKEA 'ish mechanical assembly.

For user manual, read for (applies to) any book  :palm: though arguably there hasn't been a better time to make fantastic hard copy.
In a closed society where everybody's guilty, the only crime is getting caught - Hunter S Thompson
 

Offline SL4P

  • Super Contributor
  • ***
  • Posts: 2318
  • Country: au
  • There's more value if you figure it out yourself!
Re: What Ever Happened to Well Documented User Manuals
« Reply #31 on: October 03, 2023, 10:01:11 pm »
I entered the broadcast video industry in the 70s,
The diocumentation was exceptional - Ampex, Tek etc… even the smaller bespoke products had usable documentation.

Sony were easily the best of the up and coming manufacturers, but as soon as desktop publishing was ‘anccessible’, and China came on the scene for anything, the standards dropped dramatically.

Documentation (even electronic only) is expensive to produce properly, it should start the same time as project development, and nowadays in many cases, it’s not even started until the product is ‘finished’, and the manufacturer knows whether it works or not !
Don't ask a question if you aren't willing to listen to the answer.
 


Share me

Digg  Facebook  SlashDot  Delicious  Technorati  Twitter  Google  Yahoo
Smf