Quality of documentation

For discussion of the Voltage Modular synthesis ecosystem.
andro
Posts: 130
Joined: Mon Apr 06, 2020 4:45 am

Quality of documentation

Post by andro » Tue Apr 28, 2020 9:54 am

I think Voltage Modular is just excellent and I have bought almost all the modules. I am now commencing coding some modules to be submitted to the store perhaps in a few months. So, as a software architect I am also turning my attention to good and complete and lucid documentation for my modules. The documentation for Cherry Audio modules is really excellent. But I feel, as a legitimate paying customer having spent money to acquire commercial modules here that something is lacking in the quality control check by Cherry Audio of submissions. At the risk of sounding rude, and I do not intend to be, the Module help from, PSP Audio is below any acceptable standard. Here is an example, and all the modules are similar:
PSP PEQ6 is an analog-style parametric equalizer with a wide range of settings, optimized for electronic instruments and individual track processing. Our optional "Smooth" mode engages an emulation of analog filters to provide smooth and cohesive equalization.

Also included in PSP Studio Modular Collection and PSP Ultimate Modular Collection.

PSPaudioware develops high quality audio effect and processor plug-ins. Their products garner rave reviews and endorsements from every corner of the music production, engineering, composition, and post-production worlds. www.PSPaudioware.com
That does not help me or anybody learn how to use it. One third of the text is advertising puff. I am unable to find any further detailed documentation. i think the modules are nice, but you need more. I an not specifially singliing out PSP, as other manufacturers have similar shortfalls.

Are there any representatives of Cherry Audio on the forum that could comment? Perhaps if PSP Audio reads these groups they may care to improve their product?

Please nobody take offence - I just really want to see Voltage Modular blossom and expand, and this somewhat shabby aspect goes against it.

I suppose there is a structural issue here also - the store products can properly have promotional info and comments such as being part of a bundle, but the Module Help in modules directs to the Store. So perhaps a request for enhancement could be that there is a separate location for man pages and help files.

User avatar
nekomatic
Posts: 64
Joined: Mon Jul 08, 2019 8:52 pm

Re: Quality of documentation

Post by nekomatic » Tue Apr 28, 2020 10:23 am

From a module developer point of view I would like to see a manufacrurers section of the store which can act as a user manual per each module. Something which would support hosting embedded images... Would be nice to have a visual consistency there :)

sdv
Posts: 58
Joined: Fri Mar 27, 2020 7:21 pm

Re: Quality of documentation

Post by sdv » Tue Apr 28, 2020 3:48 pm

andro wrote:
Tue Apr 28, 2020 9:54 am
The documentation for Cherry Audio modules is really excellent. But I feel, as a legitimate paying customer having spent money to acquire commercial modules here that something is lacking in the quality control check by Cherry Audio of submissions.
Check out Andy Mac's documentation. I wrote him several months ago just to thank him for the fine descriptions and consistent formatting in his PDF documentation. I can't say that it should be *the* standard for Voltage modules but I've yet to see anything better (save for CA's docs).

schoekah
Posts: 136
Joined: Wed Oct 16, 2019 3:24 am

Re: Quality of documentation

Post by schoekah » Tue Apr 28, 2020 5:27 pm

sdv wrote:
Tue Apr 28, 2020 3:48 pm
Check out Andy Mac's documentation. I wrote him several months ago just to thank him for the fine descriptions and consistent formatting in his PDF documentation.
I've been trying to figure out whether to buy an audio effects bundle or some routing and switching modules. Thanks very much for ID'g who has good documentation. As a user, that's nearly the most important thing for me, maybe even more important than sound quality (since modules that I can't figure out don't do me any good at all).

sdv
Posts: 58
Joined: Fri Mar 27, 2020 7:21 pm

Re: Quality of documentation

Post by sdv » Tue Apr 28, 2020 6:21 pm

schoekah wrote:
Tue Apr 28, 2020 5:27 pm
sdv wrote:
Tue Apr 28, 2020 3:48 pm
Check out Andy Mac's documentation. I wrote him several months ago just to thank him for the fine descriptions and consistent formatting in his PDF documentation.
I've been trying to figure out whether to buy an audio effects bundle or some routing and switching modules. Thanks very much for ID'g who has good documentation. As a user, that's nearly the most important thing for me, maybe even more important than sound quality (since modules that I can't figure out don't do me any good at all).
Andrew's docs are almost a mini-tutorial for utility modules!! His bundle is in my top three and that list includes the Core package.

andro
Posts: 130
Joined: Mon Apr 06, 2020 4:45 am

Re: Quality of documentation

Post by andro » Wed Apr 29, 2020 1:46 am

sdv wrote:
Tue Apr 28, 2020 3:48 pm
Check out Andy Mac's documentation. I wrote him several months ago just to thank him for the fine descriptions and consistent formatting in his PDF documentation. I can't say that it should be *the* standard for Voltage modules but I've yet to see anything better (save for CA's docs).
His doco is great. He is excluded from the critique, and sets a standard for all!

andro
Posts: 130
Joined: Mon Apr 06, 2020 4:45 am

Re: Quality of documentation

Post by andro » Wed Apr 29, 2020 1:49 am

So it's not the good documenters that are the topic of this thread, it's the poor ones.

Cherry Audio - can you implement some quality checking before accepting modules for sale? I;d be happy to provide feedback on such a thing.

schoekah
Posts: 136
Joined: Wed Oct 16, 2019 3:24 am

Re: Quality of documentation

Post by schoekah » Wed Apr 29, 2020 2:24 pm

andro wrote:
Wed Apr 29, 2020 1:49 am
So it's not the good documenters that are the topic of this thread, it's the poor ones.

Cherry Audio - can you implement some quality checking before accepting modules for sale? I;d be happy to provide feedback on such a thing.
Hi,
Yes, I typed out a longish reply saying that we ought to make a list of the bad ones, but didn't post it because I thought that it'd be better to keep things positive. Catch more flies with honey than vinegar, and all that kind of thing. Could get toxic around here, better to keep things positive and applaud the good ones, since we all want Cherry to succeed beyond their wildest dreams, not a place where imperfect developers get dragged through the mud.

I strongly agree that since purchases have to go through Cherry that they'll take curation seriously, make docs a prerequisite before releasing. If they can't force developers to do it then they should do it (for an even larger piece of the action) - it's quick and easy - I've done it for a living. And if they're unwilling to do this, which would be a really disappointing signal about the future of the platform, then they should make a wiki where we can do it. Of course, we could make a wiki independently, but if I'm forced to participate in an open source project then I'll go find an open source project in which to participate.

P.S.
Cherry, could you put some instructions into the manual for the formula module? Right now it's all junk about the BSD license. . .xxoo

Best wishes!

PSPaudioware
Posts: 10
Joined: Sun Sep 23, 2018 6:09 am

Re: Quality of documentation

Post by PSPaudioware » Thu Apr 30, 2020 9:25 am

We hear you.
We will publish the video manuals for each module until the end of June. I promise.

Be healthy. Stay at home.
Antoni Ozynski
www.PSPaudioware.com

andro
Posts: 130
Joined: Mon Apr 06, 2020 4:45 am

Re: Quality of documentation

Post by andro » Thu Apr 30, 2020 10:03 am

PSPaudioware wrote:
Thu Apr 30, 2020 9:25 am
We hear you.
We will publish the video manuals for each module until the end of June. I promise.
Good on you!

Post Reply