The Software Manual Thread

To many ads? Support ODJT and see no ads!

SoftJock Rick

Industry Icon
Dec 29, 2006
25,213
2,406
WitSec
www.softjock.com
How many read the manuals that come with your DJ software?


The reason I ask, is that I'm writing the manual for Rockit 4 right now, and it's been 4 days so far, and I'm only a touch more than halfway through :sqerr:

I was tempted not to even write one, since I'd bet a dollar to a donut, that 80% of my customers or better, don't even look at it -- based upon some of the support calls I get. Since I have some strategic deals in the works, that was not possible though.


So, do you read them? Just look at it when you need to? Or just call for support without bothering?

Also, what do you look for in the manual (if you do read it)? What would be the areas to concentrate on?


Seems that rather than assuming, I should get it straight from the horseys mouth, so to speak :)

Thoughts...
 
I read my software manuals when they make sense from a users standpoint.

One of the biggest issues I have with manuals is that they tend to be written with too many assumptions that the users knows more than they do about the intricacies of the software, the OS or equipment. Which I think comes from being too familiar with the application.

Too often I have found that what may keep me from having something function or function properly may only be a tiny bit of information that gets overlooked either in installation, setup and configuration under certain conditions, that doesn't get mentioned or just glossed over.

Attention to detail I think is the key to having a successful manual. Once you have a working draft, give it a beta test by some of the users who have been successful long time users as well as some newbies, then take what is learned and applied to the final version.

From my point of view, I would prefer to troubleshoot my own setup as it then allows me to learn from the experience. But then again, I am one of those who likes to "get under the hood" and get my hands dirty.
 
For me an online type of manual works very nicely or one that is downloaded to the computer complete with quick hyperlinks to certain area's... A good help index to quickly navigate to the part that you are looking for is nice... take a look at the Ots AV online manual and you'll see what I mean.
 
I feel HONORED to be mentioned, though I have no idea why I am... maybe I am listed as "the idiot guy who couldn't figure out my "sliders"? :sqerr::sqwink::sqbiggrin:
 
Read the thread about the computer guides, "Manuals??? We don't need no stinkin' manuals" :D:D:D:D:D
I usually don't read them I usuallly sort everything out pretty quick. If I get stumped then I read it :D
 
I concur with Doug. Many user manuals are written by engineers. Nothing against engineers, mind yas... just sayin' that most people who would need to refer to the user's guide are not tech-speak savvy to begin with. :)

This is why I appreciate the quick-start guides that tend to precede many user manuals. If there are issues along the way, provide a detailed reference, ie refer to Section 3 for more details.

To be honest, it is nigh impossible to cover every scenario in a software user manual. There are a gazillion OS patches and aftermarket utilities in use out there. Some run in the background and any one of 'em (or combination thereof) could cause a conflict. Many users don't know what's running on their machines. Many wouldn't know what it was if they saw it, hence all the annoying phone calls to Rick. :D

Thoughts?
 
I have only seen 2 software applications that I would call great! One was for a radio broadcast application used to schedule music for broadcast and cataloging called Selector. It's manual, no kidding, was as thick and as big as the old Sears Catalog. The other was a database application program called Alpha5 that was easy step by step directions in one book and more advanced uses and details in a second book. Plus several user written manuals for more specific uses.
 
ok so I have always marched to a different drummer and I read it unless its translated from Japanese or Chinese no offense to either races. L truly love the Japanese people especially from Okinawa (many friends from their). However many times there are so many contradictions it can mess things up worst than if you purely were to wing it. The most recent problem though occured with my Martin lights the settings for the light and the settings for the MC-1 contradict when setting up for joining the two applications.
 
Rick I never read any of the manuals I get with the software

I normally get 20mins and I could even tell you how rock-it works

I do that so often with software it aint funny....
anyway glad to see you working for a change :D
 
anyway glad to see you working for a change

Gee thanx Dennis -- I think... :sqlaugh:


With the new release, its a bit different, because a large percentage of what the program can do, isn't even on the screen.

I built it more as a platform, than a program. It has multiple interfaces, that can communicate with outside client programs, controllers, etc. For example, you can write a program that can control it from 1000 miles away via TCP/IP, or even a linked MIDI controller on another machine.

A good portion of any mods that can be done, require a knowledge of basic XML, MIDI and API programming, and writing the manual is more of a chore than it was writing the software itself... :sqerr:

Someday, I may actually finish it all, and get to go out of the house again........................................
 
Rick so you mean you are making it to be a satellite effort so I can do a gig from my house for someone in New Yawk?
 
Rick so you mean you are making it to be a satellite effort so I can do a gig from my house for someone in New Yawk?
* AHEM *

That's "Noo Yawk." I'm deducting 5 points from your score, JT. :D