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

0 Members and 1 Guest are viewing this topic.

Offline jonovidTopic starter

  • Super Contributor
  • ***
  • Posts: 1546
  • Country: au
    • JONOVID
What Ever Happened to Well Documented User Manuals
« on: September 29, 2023, 07:47:46 am »
I have noticed a trend in the use of poorly documented printed user manuals.
or is it user manuals for non technical people? lots of warnings & compliance logos but
the heart of the user manual is missing. QR code this or that
but the link is little better. be it a camping generator set or a television set.
it's not like their is a shortage of paper used in the packaging of the product.
the most egregious omission from user manuals is how the logic of the product works.
can I use both inputs and outputs at the same time? or can I disable this or that.
is it a line level or speaker audio jack? watts?
 the best user manual I have seen was the 1982 Commodore 64 ring binder user manual.
Hobbyist with a basic knowledge of electronics
 

Offline Berni

  • Super Contributor
  • ***
  • Posts: 5050
  • Country: si
Re: What Ever Happened to Well Documented User Manuals
« Reply #1 on: September 29, 2023, 08:06:37 am »
Indeed product documentation is getting dumbed down.

Most users don't even know what the specs mean, possibly even the office paper pusher tasked with writing the manual does not know what they mean, he just got some numbers from the engineering department and put them in somewhere. Most users will not read the manual and just try to use it, if it does not work they will either google the problem, or for even less tech savvy people, call up someone who is a 'computer person' and nag them to fix it.

Last week i was specing out my new PC and it was infuriating how deep i had to dig on some manufacturers public websites to find the specs for a product. They all hit you in the face with fancy product photos, marketing wank, animations... etc only when you scroll all the way trough that you find a dropdown window that you have to click to expand in order to actually see the specs. WHY?!  |O  I don't care how a SSD or motherboard looks from all sort of artistic animated angles. I wanna know how fast it is and if it works with what i want to plug it into.

 

Offline RoGeorge

  • Super Contributor
  • ***
  • Posts: 7012
  • Country: ro
Re: What Ever Happened to Well Documented User Manuals
« Reply #2 on: September 29, 2023, 08:08:53 am »
Legend says nobody ever reads the user manual.  :)
 
The following users thanked this post: schmitt trigger

Offline jpanhalt

  • Super Contributor
  • ***
  • Posts: 4005
  • Country: us
Re: What Ever Happened to Well Documented User Manuals
« Reply #3 on: September 29, 2023, 10:16:43 am »
There are still User Manuals, but useful information has been displaced with twice as many pages of warnings about what not to do, such as, don't put the cat in the dishwasher or bathe the baby in the clothes washer.
 

Offline mendip_discovery

  • Super Contributor
  • ***
  • Posts: 1024
  • Country: gb
Re: What Ever Happened to Well Documented User Manuals
« Reply #4 on: September 29, 2023, 12:34:40 pm »
Manuals don't make money. 90% of people don't use them even if they existed but as sales haven't slumped since no longer producing them then there is no gain in doing the extra work.

I often see in companies a lack of documentation for their own stuff as that takes money and time and the person who needs to write it is often too busy to do it.

I get frustrated when I am looking for details about sizes etc. only to be given the size of the box it comes in. Another was I wanted to know what the maximum fan size I could fit inside a computer case, with little or no specifications shown.

This week I wanted to look up the specifications for a device (Microtronics Blueforce) and the Technical Sheet shows very little information other than all the standards it can be used for. Sadly this is a device you have to pay the manufacturer each year to get a code so you can use it as it won't work if the calibration date expires.
Motorcyclist, Nerd, and I work in a Calibration Lab :-)
--
So everyone is clear, Calibration = Taking Measurement against a known source, Verification = Checking Calibration against Specification, Adjustment = Adjusting the unit to be within specifications.
 

Offline Tomorokoshi

  • Super Contributor
  • ***
  • Posts: 1212
  • Country: us
Re: What Ever Happened to Well Documented User Manuals
« Reply #5 on: September 29, 2023, 12:49:16 pm »
1. The product cycle is too fast. Development time is compressed, and the next product cycle has already started by the time the previous one is finishing up.

2. It takes too long to develop. Refer to a modern microcontroller manual; 1000 pages still leaves a lot out.

3. As commented above, they don't "add value" = "make money or drive sales".

4. No priority from product managers, who in their daily life would just throw it out and get a new one or go to a service shop anyway.
 

Offline rstofer

  • Super Contributor
  • ***
  • Posts: 9964
  • Country: us
Re: What Ever Happened to Well Documented User Manuals
« Reply #6 on: September 29, 2023, 05:55:25 pm »
Lower price point doesn't leave much to pay for expensive user manuals.  Take your pick:  High price with great manuals (Tek, Fluke) or low price and questionable manuals.
 

Offline Berni

  • Super Contributor
  • ***
  • Posts: 5050
  • Country: si
Re: What Ever Happened to Well Documented User Manuals
« Reply #7 on: September 29, 2023, 07:19:04 pm »
Even test gear manufacturers have gone down a LOT in the documentation. The service manuals for modern gear are mostly just how to do calibration and then some troubleshooting flowcharts that lead you to what board to replace.
 

Offline TimFox

  • Super Contributor
  • ***
  • Posts: 9003
  • Country: us
  • Retired, now restoring antique test equipment
Re: What Ever Happened to Well Documented User Manuals
« Reply #8 on: September 29, 2023, 07:24:10 pm »
The classic user and service manuals from -hp- and Tektronix date from when commercial and military purchasers assumed that their in-house maintenance personnel would maintain and repair the units.
One could actually learn things about electronics from reading them, even if one didn't own the equipment.
 
The following users thanked this post: AlbertL

Offline BILLPOD

  • Frequent Contributor
  • **
  • Posts: 386
  • Country: us
Re: What Ever Happened to Well Documented User Manuals
« Reply #9 on: September 29, 2023, 07:24:44 pm »
Most products today come with a 2 page 'Quick Guide', if you are lucky.  And if you are very lucky the manufacturer has a 'users manual' on their website, as a PDF.   And you better download that PDF, as it may not be available in a couple months.  And if you choose to print the PDF, choose your pages carefully or you will wind up with 97 pages of the manual in languages you've never heard of :rant:
 
The following users thanked this post: AlbertL

Online Bud

  • Super Contributor
  • ***
  • Posts: 7276
  • Country: ca
Re: What Ever Happened to Well Documented User Manuals
« Reply #10 on: September 29, 2023, 07:52:06 pm »
Even test gear manufacturers have gone down a LOT in the documentation. The service manuals for modern gear are mostly just how to do calibration and then some troubleshooting flowcharts that lead you to what board to replace.
I've seen Keysight service documentation saying "Service policy: device replacement". So there is no "servicing", the old unit gets srapped and customer gets a net new device.
The best service guide you can find for many test gear is this EEVBlog forum  :-+
Facebook-free life and Rigol-free shack.
 

Offline PwrElectronics

  • Regular Contributor
  • *
  • Posts: 107
  • Country: us
Re: What Ever Happened to Well Documented User Manuals
« Reply #11 on: September 29, 2023, 09:05:32 pm »
For sure, 20-30 pages of cautions and other such warnings in 10+ Languages but scant information on how to actually use the product or even rarer; to service/repair it.

Actual use instructions are 1 page at most and leave out any useful details that could confuse anyone unless a power user (like most here).
 

Offline schmitt trigger

  • Super Contributor
  • ***
  • Posts: 2431
  • Country: mx
Re: What Ever Happened to Well Documented User Manuals
« Reply #12 on: September 29, 2023, 09:20:07 pm »

I've seen Keysight service documentation saying "Service policy: device replacement". So there is no "servicing", the old unit gets srapped and customer gets a net new device.


And sadly the unit becomes part of the growing pile of E-waste.
Or….ICs are recycled and end up in the grey market.
 

Offline alm

  • Super Contributor
  • ***
  • Posts: 2903
  • Country: 00
Re: What Ever Happened to Well Documented User Manuals
« Reply #13 on: September 30, 2023, 06:24:48 pm »
Even test gear manufacturers have gone down a LOT in the documentation. The service manuals for modern gear are mostly just how to do calibration and then some troubleshooting flowcharts that lead you to what board to replace.
Certainly the quality has gone down a lot since the eighties and earlier. But I'll still take a manual with block diagram and adjustments over instruments without any adjustment instructions *cough Siglent where people have to reverse-engineer how to adjust cough*.

Online coppercone2

  • Super Contributor
  • ***
  • Posts: 11342
  • Country: us
  • $
Re: What Ever Happened to Well Documented User Manuals
« Reply #14 on: September 30, 2023, 06:50:18 pm »
the cost to society from unrepairable objects is probobly greater then dealing with the court cases of bad repairs

nothing like loads of people being totally stuck and unable to save and advance

like the dumb nanny that clogged the pipe with baby wipes because she could not figure out how to rinse a wash cloth

with the amount of risk people take to make money (job stress, health, unsafe jobs, commutes, etc), you can't even say its safer to spend extra money on getting a new device. Like its a risk to repair but so is not saving money, being tied to a job because of reoccurring expenses, etc. There seems to be this notion that for some reason getting your pay check is risk free. I.e. moving, taking a job you are more comfortable with (even with lower pay, since its relative to your expenses), taking time off, using money for health/relaxation reasons, etc.
« Last Edit: September 30, 2023, 07:02:34 pm by coppercone2 »
 

Offline Coordonnée_chromatique

  • Regular Contributor
  • *
  • Posts: 208
  • Country: fr
Re: What Ever Happened to Well Documented User Manuals
« Reply #15 on: September 30, 2023, 07:48:02 pm »
1. The product cycle is too fast. Development time is compressed, and the next product cycle has already started by the time the previous one is finishing up.

The documentation is dead since it had been poped out of the modern companies projects processes because the manuals have to be written after the projects endings, and the staff is dissolved or on another project when the documentation had to be written.
A good notice is written by the ENTIRE STAFF that had worked on a product, and a redactor is just here to collect and organize the data.
« Last Edit: September 30, 2023, 07:52:20 pm by Coordonnée_chromatique »
 

Online SiliconWizard

  • Super Contributor
  • ***
  • Posts: 15800
  • Country: fr
Re: What Ever Happened to Well Documented User Manuals
« Reply #16 on: September 30, 2023, 09:26:37 pm »
When you look at the quality of old HP manuals, the current situation is very depressing.
Heck, it was not just for expensive gear. Yes, even cheap home computers of the 80's (at least many of them) came with fantastic manuals.
 

Online Smokey

  • Super Contributor
  • ***
  • Posts: 3046
  • Country: us
  • Not An Expert
Re: What Ever Happened to Well Documented User Manuals
« Reply #17 on: September 30, 2023, 09:46:47 pm »
I bought a welder from Everlast.  I got it direct, not through amazon or some reseller.  It's been a great welder.  I want to make a point I'm not complaining about the welder itself...

but...

In the box was a terrible quality laser printed paper manual... It was hard to read both because of the obviously translated nature and because the printer needed more toner. 
And best of all... it was for the wrong model welder.
 

Offline Coordonnée_chromatique

  • Regular Contributor
  • *
  • Posts: 208
  • Country: fr
Re: What Ever Happened to Well Documented User Manuals
« Reply #18 on: October 01, 2023, 04:55:31 am »
obviously translated nature

Here you can read my BS level in English, few decades ago i was able to write technical documentations that were audited by extrenal cabinets of linguists and cerified by pharmaceutical big companies.
My competence is lost since i've been putted in concurence with people that d'ont speak or read english, and use google translations... only the bests survive  :-DD
 

Offline schmitt trigger

  • Super Contributor
  • ***
  • Posts: 2431
  • Country: mx
Re: What Ever Happened to Well Documented User Manuals
« Reply #19 on: October 01, 2023, 10:10:03 pm »
Back in the late 1970s I serviced professional audio equipment. The most complex were of course multi-track tape recorders. These were magnificent examples of electronic AND mechanical design.
I remember a particular 8-track AMPEX machine. The detail level in the manual was beyond extraordinary. It required not only multiple electrical adjustments, but mechanical ones too.
 

Offline TERRA Operative

  • Super Contributor
  • ***
  • Posts: 3169
  • Country: jp
  • Voider of warranties
    • Near Far Media Youtube
Re: What Ever Happened to Well Documented User Manuals
« Reply #20 on: October 02, 2023, 02:26:29 pm »
Last week i was specing out my new PC and it was infuriating how deep i had to dig on some manufacturers public websites to find the specs for a product. They all hit you in the face with fancy product photos, marketing wank, animations... etc only when you scroll all the way trough that you find a dropdown window that you have to click to expand in order to actually see the specs. WHY?!  |O  I don't care how a SSD or motherboard looks from all sort of artistic animated angles. I wanna know how fast it is and if it works with what i want to plug it into.

I just bought an RTX4070 Ti GPU and I wanted to know the power draw of the card itself to make sure it would be ok in my eGPU setup without upgrading the PSU.
There was NO information on the total wattage on the manufacturers website beyond 'Recommend a 550W PSU' in regards to the power required by an entire average gaming PC. I had to find the numbers as measured by a review website...

"No user serviceable parts inside" happened.

1980s car made in socialist economy had a 100-page booklet (user manual) with important parts list, electrical wiring diagrams and basic mechanical maintenance instructions. Full service manual (with detailed specs, drawings, dimmensions, mechanical tolerances etc.) was also available for purchase, even to regular people. It was expected that user may have to service his car in his home workshop.

Late 2010s car came with a 300-page book with maybe 5 pages of valuable information (tire pressure, lug nut torque, oil type etc.) and the rest is bullshit like: "contact your dealer" or "don't stick your male appendage into a 12V lighter socket". Any service manuals are either unofficial (think Haynes books) or under NDA and have to be pirated (if you're lucky to find one)  :palm: Same thing for bicycles. Lots of tl;dr that you have to be very careful when doing 15 km/h on a dirt road and one page with important torque specs and recommendation to leave any servicing for professional bicycle workshop.

Of course, there's not much point comparing 1980s car to todays complex electro-mechanical marvels, but still...

If I had to guess, I'd say it's possible that if manufacturer provided service instructions, then he could be held liable for botched DIY repairs where user ends up hurting himself. So everything is dumbed-down and if user damages the device or hurts himself, it's his own fault.

I had to pay 30,000yen (about US$250 at the time) to get the workshop manuals and full schematics on the workshop CD from Toyota for my 2019 model car.
(If anyone has a 2019 model facelift Third-gen 80-series Toyota Noah minivan, I can provide all schematics etc in pdf form, a few even translated. :D )
The provided user manual was mostly the usual 'this is how you turn on the headlights and how to open a window, and how to call for assistance if you have a flat tyre' bullshit. They don't even have a recommended service schedule by kilometers anymore, its all by time (What if I only do 1000km every 6 months going to the shops on the weekend, or I do 50,000km in the same time as a traveling salesman?). I had to pry the real info from the mechanics which turned out to be the usual 10,000km or 20,000km if using premium oil etc.... It's all getting dumbed down to drooling mouth-breathing levels.


Although, a portion of the problem regarding test equipment is the highly integrated nature of things with SMD this, BGA that, firmware everywhere with custom chips sprinkled around that make repair a much harder thing to do than the much simpler SMD and through-hole construction of the early 90's and earlier.


I did some time in documentation (for domestic airconditioners and HEMS equipment). There were more than a few products that I overhauled the manuals for, and poured in much more detailed information than was originally included.
I'm pretty sure that there is a place for me in Documentation Valhalla for my modest efforts. :-DD
Where does all this test equipment keep coming from?!?

https://www.youtube.com/NearFarMedia/
 

Offline BeBuLamar

  • Super Contributor
  • ***
  • Posts: 1421
  • Country: us
Re: What Ever Happened to Well Documented User Manuals
« Reply #21 on: October 02, 2023, 02:47:48 pm »
It's kind of value added thing. How much value do most customers put on a good manual? Very little as few read them and thus manufacturers don't bother with the manual any more. Not so much the cost of printing or to save paper. Even online manuals now are very bad. They don't spend money on writing good manuals any more.
 

Offline AG6QR

  • Frequent Contributor
  • **
  • Posts: 866
  • Country: us
    • AG6QR Blog
Re: What Ever Happened to Well Documented User Manuals
« Reply #22 on: October 02, 2023, 03:27:30 pm »
The first computer printer I purchased, in approximately 1988, was an Epson LX-80, a basic 9-pin impact dot matrix printer. It came with a 158-page manual which included all of the control codes to print both text and graphics in various ways, along with lots of example programs (in BASIC, of course, since that was the language that most computers used with this printer would have had built-in).  The technical information contained in that manual would have been all the information needed to write a driver for that printer to work with any software package.

I found the manual on-line today.  https://files.support.epson.com/pdf/lx80__/lx80__u1.pdf   It is a beautiful example of manuals of the day. Packed with technical information, clearly written in very understandable English.

What happened?  I suspect it was something along the lines of:

We did a survey and found that most of our customers aren't reading the manuals.  It costs a lot to produce those manuals. In the interest of fairness to all customers, we decided to write our manuals so that the people who read them don't gain an unfair advantage over the ones who toss them in the trash immediately.
 

Offline johnk0gcj@gmail.com

  • Contributor
  • Posts: 18
  • Country: us
Re: What Ever Happened to Well Documented User Manuals
« Reply #23 on: October 02, 2023, 06:27:10 pm »

I realize that this sounds radical, but do you suppose money has anything to do with this?

 

Offline Neilm

  • Super Contributor
  • ***
  • Posts: 1560
  • Country: gb
Re: What Ever Happened to Well Documented User Manuals
« Reply #24 on: October 02, 2023, 06:34:14 pm »
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

Two things are infinite: the universe and human stupidity; and I'm not sure about the the universe. - Albert Einstein
Tesla referral code https://ts.la/neil53539
 


Share me

Digg  Facebook  SlashDot  Delicious  Technorati  Twitter  Google  Yahoo
Smf