What makes a good manual?

[Toaster]

One of my gripes with the Octatrack manual was that you would need to flip between different sections to complete one operation

I still have PTSD from that fucking thing. That manual may as well have been written in a foreign language. In addition, every iteration of the software basically obsoleted the manual.

[jasonw22]

Table of Contents

An index is also quite helpful, if well done.

[sandy]

I like manuals that are fairly basic and to the point. Something that gives me the information I need to explore a module. I appreciate ones that go to the effort of having examples etc but it’s not something for me that defines a good manual.

A decent diagram of the module.
Description of the inputs, outputs, knobs and LEDs.
Voltage ranges for inputs and outputs.
Knob behaviour - attenuate/attenuverter etc - does it differ if CV is present or not?
LED behaviour, especially if multi-colour.
If there’s any menu driven or multi-functional control then a diagram and description of how to use that.
For Euro modules in particular - clear power cable instructions. I don’t give a hoot about the red stripe - tell me which side is -12v (and ideally have it marked on the pcb!)

Examples - I like the Mutable Instruments manuals. Short, to the point and they provide the sort of information I want.

[disquiet]

if the manual is distributed via pdf

This one is important to me, at least: manuals should be available in a format that is easily accessible. One good thing about PDFs is that you can write on them, mark them up, take screenshots of important information. (I find a lot of iOS apps in particular depend on online-only manuals. You’re working on an iPad, for example, and you click the How To section, and it tries to connect to a website, which I might not be able to access at that moment because I might be somewhere with poor reception.)

[b_w]

I had a minibrute 2s for a minute and I think of their manual to be an especially good one. I found it to be exhaustive without being exhausting.

It had a clear table of contents, so one could skip over some of the introductory stuff if they chose. It also employed plain, yet concise language that beginners and seasoned musicians could understand. It had great visuals, using both color and symbology, to convey ideas and concepts. The end of the manual has a nifty little section for all of the “shift functions” listed out for reference. That’s nice.

But the best thing it had going for it was the “cook book” of different patches to both understand how the machine functions and where one could begin a new patch. You should check it out!

[b_w]

That said, I also appreciate one-pagers that allow the user to explore with minimal base knowledge provided by the manufacturer.

[disquiet]

Yeah, I appreciate a quick-start guide, too.

[murray]

A lot already mentioned, but I like colors (if there are) to be differentiated enough that I don’t have problems with my mild++ color blindness.

[alanza]

in theory I agree with your list, but I find that Mannequins, in breaking most of these rules, have made a much more generative (ugh, that word) manual than any of the other Eurorack manuals I’ve read, while still remaining plenty useful. The W/ manual even turned me on to the music of Dakim as part of a useful use suggestion.

---

I like the Max/MSP help patches as an example of the potential software documentation has. (the lack of a thorough-going general manual bothers me, though)

Ableton’s manual, I have to say, has been the most pleasant surprise to read from; the explanation of what they’ve modeled each piece after, from the session view down to the device parameters is clear, concise and includes plenty of inspiration in the form of asides.

[jasonw22]

I agree that max help patches are fantastic. And that’s the only bit I’m going to reply to.

[tsintsi]

for hardware, full electrical schematics are always appreciated

edit: or an easily attainable service manual!

[desolationjones]

Functional block diagrams.

Perhaps they just appeal to me as an engineer, but also they communicate using a language which is already known to modular synthesists: patching. I know it can take a lot of magic (ie mysticism) out of a module to shine a spotlight on its guts… but so many modules are just a “patch-in-a-box” and I want to see it!

[hamildad]

ARP 2600 manual is one of the greatest, assumes nothing and so acts as a very good introduction to subtractive synthesis, it has a personality and sounds like one guy talking to you, because it is.

There is humour and digressions and finally some nice patch examples that ramp up in difficulty to the end of the book.

Also the diagrams are hand drawn which is adorable

[Simeon]

My kind of manual

[Ithacus]

Madrona labs manuals are a joy to read.

They are fun, detailed, and have amazing artwork to boot. When reading you get the impression a lot of love went into them.

[disquiet]

I’m always amazed by module manuals that don’t tell you where the power gets plugged in. It’s not always self-evident.

@hamildad I’ve never read the ARP 2600 manual, except in excerpts I’ve come across. I found a copy and will now. Thanks!

@Ithacus I agree about Madrona. I only have Aalto, and the manual pretty much sold me on the software.

[jasonloeffler]

As my eyes grow older, I appreciate a manual with a large font size and ample line spacing.

[disquiet]

Ha! Right there with you. It’s why I read many of these PDFs on an iPad.

[philmaguire]

Videos and patch diagrams! I don’t process written instructions/descriptions well, so clear communication that is visual in other ways is vital.

[lijnenspel]

Thought I’d share some scans of the early Ciat Lonbarde Fyrall manual. Wish he still did printed manuals for his instruments. This manual really reflects the nature of the instrument and gives you inspiration with the possibility to go deeper if you’re willing enough to decipher.