Previous Thread
Index
Next Thread
Print Thread
Go To
#687939 12/04/21 06:36 AM
Band-in-a-Box Wishlist
Joined: Jan 2015
Posts: 1,897
Expert
OP Offline
Expert
Joined: Jan 2015
Posts: 1,897
I thought I'd start a thread here with what I hope are constructive thoughts on the manuals, and ideas on how to make them easier to read and understand.

I'd earlier said in a thread started by malevans that I thought the manual was "cluttered", so I thought I should expand on that. Someone also mentioned the Reaper manual as quite a good example, though there are several others. Reaper, BTW, have a footnote on each page with a link to LULU.com who are one of several organisations that offer printed manuals on demand.


Some of that "clutter" is due to probable documentation conventions, which could be made more concise by declaring those conventions somewhere, possibly right near the start of the manual. For example the convention used for buttons: [Style] if explicitly defined in the conventions as a button, would negate the need within the body text to say "using the [Style] button". Icons are good, though can be confusing when there are multiple GUI styles available, e.g., the monochrome or coloured icons styles.

Similarly predefine font meanings. Generally, the fewer fonts the better, though in manuals for software, "fewer" is usually quite hard to achieve.

Similarly sequences of actions. I personally tend to use, e.g., File->Load_Style_Special->"filename"->[OK] to describe a sequence. I note that the | symbol is used in some places, which is OK (though for me | means "or"). This would reduce the desire/need to use verbal descriptions.

A common problem in the manuals for many applications is that a section describing something, e.g., perhaps the MIDI Settings, without telling the user, right at that point, how to get to that something. Incidentally, I picked that from the index, expecting to see the instructions for setting up a MIDI device.

During a main explanation, focus upon a "preferred" way to do something, offering "other ways to do this" as a separate item. Then each of the sequences can be described completely in and of itself.

Hierarchically numbering every header helps navigation, and also helps suggestions or error-reports to focus closely to the correct location. In my specifications, where I need to incorporate similar changes, I usually number every paragraph, though most word-processors seem appallingly bad at doing that properly. A fall-back I've used is to number every line on every page, which is something with which most word-processors seem more adept. "Changed" indicators are often useful if the tools support them. You almost certainly already do that internally; it can be less useful in a published document, as it add clutter.

White-space, including indenting, helps quick navigation by eye and usually makes the document look nicer. On a .pdf document, white-space costs nothing. Printed it can, but better clarity can often reduce the number of pages needed.
It's worth looking at the keyboard shortcuts section and considering how an additional line before each sub-header and indenting the keys from that header would make it easier to use. At present, it isn't easy to pick out the subheadings from the keys. It's worth noting that many publishers consider the white-space to be the most important part of a document, yet we ordinary folk tend to forget it, particularly when close to a particular text. It can pay sometimes, just to hold a page at arms-length and look at it.

It's surprising how much the choice of font affects the appearance of a document. Some publishers are quite obsessive about fonts. I can see why. I take some care with them, but I'm neither obsessive, nor really a publisher.

Good indices are a Godsend, but are also darned hard work to do well. The best indices are defined manually by the authors, based upon good keywords by which people will want to look for things, but that's a huge task which most of us baulk at. Sometimes what's important is to exclude things that are not so helpful. BiaB's index is not actually bad, though it could be better.

I think a separate sub-section just for the chord-entry shortcuts might be worthwhile.

In quite a few documents, I despair at the standard of grammar and punctuation. I have to say that I haven't noticed any real howlers, no "xxx was charged with murder in the court today".

The following may well not be feasible with BiaB now, and is much more software design than manual. Some software has a philosophy: "Everything that you can do with any object will be found in a right-click menu on that object".

I think I've written more than enough for now.


Jazz relative beginner, starting at a much older age than was helpful.
Kawai MP6, Korg M50, Ui24R, Saffire Pro 40.
AVL:MXE Linux; Windows 11; Win8.1: Scarletts
BIAB2022 UltraPAK, Reaper, a bunch of stuff.
Band-in-a-Box Wishlist
Joined: Dec 2018
Posts: 108
R
Apprentice
Offline
Apprentice
R
Joined: Dec 2018
Posts: 108
Very Well said GS. I concur.
I have, in the past, taken content out of the pdf into Word to reformat for precisely the reasons you outline here.

the manual is large and it is superb to have it in two file formats. I Often search the file for info I am after.

How do you feel about a collaborative community project to reformat the Manual?
Assuming we obtain PGM consultative support for the project. And use of IP approval.
Use something like GitHub for version control

RrR

Band-in-a-Box Wishlist
Joined: Jan 2015
Posts: 1,897
Expert
OP Offline
Expert
Joined: Jan 2015
Posts: 1,897
Originally Posted By: RoyReddy
How do you feel about a collaborative community project to reformat the Manual?
Assuming we obtain PGM consultative support for the project. And use of IP approval.
Use something like GitHub for version control

RrR

It's certainly something I would be prepared to keep in mind. I think there's a good change PGM may be amenable to the idea as, it seems to me, they must know the manual has been less than perfect for some time, but I suspect they also well understand that it'll likely be a huge task.

If they were amenable, then some dialogue to firm up ideas like mine above, though not necessarily actually mine above ... I'm sure others have comparable thoughts ... then we could establish a convention and potentially have many people working towards the same goal.

I just thought to look if there are other language versions. There appears not to be. That's a relief for now, but offers perhaps both a challenge and an opportunity for the future.


Jazz relative beginner, starting at a much older age than was helpful.
Kawai MP6, Korg M50, Ui24R, Saffire Pro 40.
AVL:MXE Linux; Windows 11; Win8.1: Scarletts
BIAB2022 UltraPAK, Reaper, a bunch of stuff.
Band-in-a-Box Wishlist
Joined: Jun 2012
Posts: 3,567
J
Veteran
Offline
Veteran
J
Joined: Jun 2012
Posts: 3,567
Originally Posted By: RoyReddy
How do you feel about a collaborative community project to reformat the Manual?
Assuming we obtain PGM consultative support for the project. And use of IP approval.
Use something like GitHub for version control

It could possibly work if you had enough people who were passionate and capable enough. They would have to put in a ton of work. And even if they succeeded would need to reconvene every year to cover new and changed features. In my life in tech I have seen many attempts at a project like this but not many successes. And even the successes were never sustained for long. My opinion is this effort has to come from those who have a vested interest, namely, PGM.

Band-in-a-Box Wishlist
Joined: Jan 2015
Posts: 1,897
Expert
OP Offline
Expert
Joined: Jan 2015
Posts: 1,897
Originally Posted By: JohnJohnJohn
My opinion is this effort has to come from those who have a vested interest, namely, PGM.

Indeed.

My reason for posting was to share some ideas that may help and perhaps to encourage PGM, rather than to suggest a user-authored manual.

Also, if I'm honest, the brutal and vindictive way I was treated by my last employer has left me struggling with some mental issues, particularly around focus on a task. I used to be bullet proof unstoppable. Now I struggle at least some of the time most days.


Jazz relative beginner, starting at a much older age than was helpful.
Kawai MP6, Korg M50, Ui24R, Saffire Pro 40.
AVL:MXE Linux; Windows 11; Win8.1: Scarletts
BIAB2022 UltraPAK, Reaper, a bunch of stuff.
Band-in-a-Box Wishlist
Joined: Dec 2018
Posts: 108
R
Apprentice
Offline
Apprentice
R
Joined: Dec 2018
Posts: 108
OK that makes sense. NP

Previous Thread
Next Thread
Go To

Link Copied to Clipboard
ChatPG

Ask sales and support questions about Band-in-a-Box using natural language.

ChatPG's knowledge base includes the full Band-in-a-Box User Manual and sales information from the website.

PG Music News
Update Your PowerTracks Pro Audio 2024 Today!

Add updated printing options, enhanced tracks settings, smoother use of MGU and SGU (BB files) within PowerTracks, and more with the latest PowerTracks Pro Audio 2024 update!

Learn more about this free update for PowerTracks Pro Audio & download it at www.pgmusic.com/support_windows_pt.htm#2024_5

The Newest RealBand 2024 Update is Here!

The newest RealBand 2024 Build 5 update is now available!

Download and install this to your RealBand 2024 for updated print options, streamlined loading and saving of .SGU & MGU (BB) files, and to add a number of program adjustments that address user-reported bugs and concerns.

This free update is available to all RealBand 2024 users. To learn more about this update and download it, head to www.pgmusic.com/support.realband.htm#20245

The Band-in-a-Box® Flash Drive Backup Option

Today (April 5) is National Flash Drive Day!

Did you know... not only can you download your Band-in-a-Box® Pro, MegaPAK, or PlusPAK purchase - you can also choose to add a flash drive backup copy with the installation files for only $15? It even comes with a Band-in-a-Box® keychain!

For the larger Band-in-a-Box® packages (UltraPAK, UltraPAK+, Audiophile Edition), the hard drive backup copy is available for only $25. This will include a preinstalled and ready to use program, along with your installation files.

Backup copies are offered during the checkout process on our website.

Already purchased your e-delivery version, and now you wish you had a backup copy? It's not too late! If your purchase was for the current version of Band-in-a-Box®, you can still reach out to our team directly to place your backup copy order!

Note: the Band-in-a-Box® keychain is only included with flash drive backup copies, and cannot be purchased separately.

Handy flash drive tip: Always try plugging in a USB device the wrong way first? If your flash drive (or other USB plug) doesn't have a symbol to indicate which way is up, look for the side with a seam on the metal connector (it only has a line across one side) - that's the side that either faces down or to the left, depending on your port placement.

Update your Band-in-a-Box® 2024 for Windows® Today!

Update your Band-in-a-Box® 2024 for Windows for free with build 1111!

With this update, there's more control when saving images from the Print Preview window, we've added defaults to the MultiPicker for sorting and font size, updated printing options, updated RealTracks and other content, and addressed user-reported issues with the StylePicker, MIDI Soloists, key signature changes, and more!

Learn more about this free update for Band-in-a-Box® 2024 for Windows at www.pgmusic.com/support_windowsupdates.htm#1111

Band-in-a-Box® 2024 Review: 4.75 out of 5 Stars!

If you're looking for a in-depth review of the newest Band-in-a-Box® 2024 for Windows version, you'll definitely find it with Sound-Guy's latest review, Band-in-a-Box® 2024 for Windows Review: Incredible new capabilities to experiment, compose, arrange and mix songs.

A few excerpts:
"The Tracks view is possibly the single most powerful addition in 2024 and opens up a new way to edit and generate accompaniments. Combined with the new MultiPicker Library Window, it makes BIAB nearly perfect as an 'intelligent' composer/arranger program."

"MIDI SuperTracks partial generation showing six variations – each time the section is generated it can be instantly auditioned, re-generated or backed out to a previous generation – and you can do this with any track type. This is MAJOR! This takes musical experimentation and honing an arrangement to a new level, and faster than ever."

"Band in a Box continues to be an expansive musical tool-set for both novice and experienced musicians to experiment, compose, arrange and mix songs, as well as an extensive educational resource. It is huge, with hundreds of functions, more than any one person is likely to ever use. Yet, so is any DAW that I have used. BIAB can do some things that no DAW does, and this year BIAB has more DAW-like functions than ever."

Convenient Ways to Listen to Band-in-a-Box® Songs Created by Program Users!

The User Showcase Forum is an excellent place to share your Band-in-a-Box® songs and listen to songs other program users are creating!

There are other places you can listen to these songs too! Visit our User Showcase page to sort by genre, artist (forum name), song title, and date - each listing will direct you to the forum post for that song.

If you'd rather listen to these songs in one place, head to our Band-in-a-Box® Radio, where you'll have the option to select the genre playlist for your listening pleasure. This page has SoundCloud built in, so it won't redirect you. We've also added the link to the Artists SoundCloud page here, and a link to their forum post.

We hope you find some inspiration from this amazing collection of User Showcase Songs!

Congratulations to the 2023 User Showcase Award Winners!

We've just announced the 2023 User Showcase Award Winners!

There are 45 winners, each receiving a Band-in-a-Box 2024 UltraPAK! Read the official announcement to see if you've won.

Our User Showcase Forum receives more than 50 posts per day, with people sharing their Band-in-a-Box songs and providing feedback for other songs posted.

Thank you to everyone who has contributed!

Forum Statistics
Forums66
Topics81,581
Posts734,680
Members38,499
Most Online2,537
Jan 19th, 2020
Newest Members
Tusar Sarkar, RTW, wtsy365, DerFlex, xabialonso259@gmai
38,499 Registered Users
Top Posters(30 Days)
MarioD 200
DC Ron 108
dcuny 87
WaoBand 75
Today's Birthdays
AlberMaxSax, Lloyd Morris
Powered by UBB.threads™ PHP Forum Software 7.7.5