Cut Down version of the Manual

sa
saoir
Posts: 361
Joined: Sat May 04, 2013 10:40 pm
Platform: Mac

Thu Jun 19, 2014 2:37 pm Post

Been using Scrivener for about six months now. Try to use the Manual, but I regret to say it's not the best. I have been online for decades and using software and software manuals for a long time.

I suggest that Scrivener would benefit greatly from having a revamped Manual created for beginners/ and basic users, with the current manual being the reference and power user version.
I suggest that one could go through the existing manual and edit out, and rearrange, rather than start from scratch. A much faster and easier process.
I do realise the FAQs are good and the tutorials wonderful. But a simplified, streamlined, clear and easy to read manual is a fantastic asset to any software. And I believe it would help keep a lot of people who flirt with the program and move off because it seems complex.

My 2¢
Howard Brittain

Author of just published "Vineyard"
An MI5/Thriller.
Blog

dr
druid
Posts: 1721
Joined: Fri Jun 22, 2007 2:29 pm
Platform: Mac, Win + Linux
Location: Princeton NJ, USA

Thu Jun 19, 2014 2:56 pm Post


User avatar
KB
Site Admin
Posts: 20716
Joined: Tue Jun 13, 2006 11:23 pm
Platform: Mac
Location: Truro, Cornwall
Contact:

Thu Jun 19, 2014 2:59 pm Post

The feedback we get for the manual is overwhelmingly positive. It is intended as a comprehensive guide to Scrivener, not something you would ever read all the way through, but something you dip into to find out what you need.

What you are looking for is the interactive tutorial project, available from Help > Interactive Tutorial in the project. I get the impression that you have never been through this, which is probably why a few of the concepts have been awkward for you. This interactive tutorial is intended to do exactly what you want - get beginners up and running by covering all of the core concepts, with the benefit that they are using the program as they learn since the tutorial is a Scrivener project.
"You can't waltz in here, use my toaster, and start spouting universal truths without qualification."

sa
saoir
Posts: 361
Joined: Sat May 04, 2013 10:40 pm
Platform: Mac

Fri Jun 20, 2014 12:12 am Post

That looks good. Who knew it was there :roll:
Howard Brittain

Author of just published "Vineyard"
An MI5/Thriller.
Blog

User avatar
nom
Posts: 1909
Joined: Sun Aug 31, 2008 12:02 am
Platform: Mac + iOS
Location: Melbourne, Australia
Contact:

Fri Jun 20, 2014 12:25 pm Post

saoir wrote:That looks good. Who knew it was there :roll:


This is how I found it. :wink:
Screen Shot.png
Screen Shot.png (273.04 KiB) Viewed 1254 times
Complete and utter NOMsense.
Image

sa
saoir
Posts: 361
Joined: Sat May 04, 2013 10:40 pm
Platform: Mac

Fri Jun 20, 2014 1:35 pm Post

Ah. Never saw that window. Maybe the first day. Tks.
Howard Brittain

Author of just published "Vineyard"
An MI5/Thriller.
Blog

Br
Briar Kit
Posts: 1787
Joined: Thu Apr 04, 2013 9:04 am
Platform: Mac

Fri Jun 20, 2014 1:49 pm Post

KB wrote:The feedback we get for the manual is overwhelmingly positive. It is intended as a comprehensive guide to Scrivener, not something you would ever read all the way through, but something you dip into to find out what you need.


Not something to read all the way through?

Am I the only one?
Account closed January 2017

User avatar
Jaysen
Posts: 6163
Joined: Mon Dec 17, 2007 4:00 am
Platform: Mac + Windows
Location: East-Be-Jesus-Nowhere SC, USA

Fri Jun 20, 2014 1:56 pm Post

Briar Kit wrote:Am I the only one?

I would suggest… yes. But not just for this reason.

:)
Jaysen

I have a wife and 2 kids that I can only attribute to a wiggle, a giggle, and the realization that she was out of my league so I might as well be happy with her as a friend. 26 years marriage later, I can't imagine life without her. -Me 10/7/09

Image

ho
hotte
Posts: 9
Joined: Thu Apr 24, 2014 8:08 pm
Platform: Windows
Location: Tampa Bay Area, Florida, USA
Contact:

Thu Jul 10, 2014 7:54 pm Post

Being that my platform is Windows, I find the combination Mac-Windows user manual very confusing. As to the tutoring, since it is strictly for Mac, it doesnt help me at all. Also, it would be nice to have a succinct manual and tutoring exclusively for Windows; with less descriptions and more detailed examples of how to execute the commands, and what exactly they accomplish. I tried to understand the function of "Keywords" and how to use the feature in a long project. Unfortunately I still don't understand it, and help on this would be greatly appreciated.

Hotte

User avatar
AmberV
Posts: 23699
Joined: Sun Jun 18, 2006 4:30 am
Platform: Mac + Linux
Location: Ourense, Galiza
Contact:

Thu Jul 10, 2014 8:04 pm Post

Well the Scrivener project itself is not meant to be used as a primary reference. Please use the PDF that is provided to you with your installation on Windows (press F1). I use one project to produce both manuals because a large majority of the text is identical, and it would greatly amplify how much work I have to do when extensively editing it, if I had to make all of those edits twice to two different projects—and all for something that, like I say, isn’t meant to be used as a primary reference. The only reason I make the project available is as a demonstration of MultiMarkdown and large-scale technical projects, for those that are curious about what features we use and how we use them to make our own documentation.

As for keywords, as said above, I think the tutorial is what you are looking for if you want a brief summary. Keywords are explained with a few practical examples that should cover 99% of what you'll need to make good use of them. If you need to figure out how to do a OR style project search for a selected keyword list—that's what the manual is for.
.:.
Ioa Petra'ka
“Whole sight, or all the rest is desolation.” —John Fowles

Mo
MosesGhostwriter
Posts: 17
Joined: Tue Jul 29, 2014 7:23 am
Platform: Mac
Location: Deep in the Heart of Texas

Thu Jul 31, 2014 11:34 pm Post

Writing as someone who has dl'ed Scrivener 3 days ago and am making mistakes around this thing every step I make, I long for a simple manual as well. Actually, I would vote for three products. 1) a simple project to show how to set up a minimal document such as a high school student might be assigned to research and write. 2) a bit more explanatory project as you have in your interactive tutorial so one has by now enough time under their belt to absorb the material. and 3) the PDF document that in the full blown manual for Scrivener.
This approach I used when I taught audio at a technical college to students whose most advanced understanding of the tech side of audio was figuring out how to load music onto their iPods.
It also has the benefit of helping someone who remembers that you can do something like what they want but can't come up with the search criteria to find it in the PDF. The answer might not be in the simplest version but often that triggers a clue where to find what they need.

My 2¢

JC

User avatar
AmberV
Posts: 23699
Joined: Sun Jun 18, 2006 4:30 am
Platform: Mac + Linux
Location: Ourense, Galiza
Contact:

Mon Aug 04, 2014 7:48 pm Post

We have been considering various approaches, such as you describe, but in the meanwhile do note that our current iteration of this can be found on the videos page.

Additionally, although it does not result in a practical example that could be useful (such as a high-school essay), the Quick Tour chapter in the user manual PDF itself is indeed meant to be the quick-and-dirty introduction for those that learn better off of a text than a narrated video. It should be enough to get anyone to the point where they can start writing, and using basic organisation to sort out their writings—then they can go through the interactive tutorial at leisure.
.:.
Ioa Petra'ka
“Whole sight, or all the rest is desolation.” —John Fowles

User avatar
pigfender
Posts: 2744
Joined: Tue Oct 12, 2010 10:25 am
Platform: Mac, Win + iOS
Location: I share a head with a great many personalities
Contact:

Mon Aug 04, 2014 8:02 pm Post

Does nobody just dive in and twiddle every knob to see what they do anymore?
"Some dice only have sixes." nom, 19 Oct 2013
"Piggy, I'm beginning to wonder if you are the best person to take advice from." Jaysen, 26 Sept 2014

Image
http://www.pigfender.com | http://www.novelinaday.com

Image

User avatar
nom
Posts: 1909
Joined: Sun Aug 31, 2008 12:02 am
Platform: Mac + iOS
Location: Melbourne, Australia
Contact:

Tue Aug 05, 2014 12:08 pm Post

pigfender wrote:Does nobody just dive in and twiddle every knob to see what they do anymore?

There are other ways? :oops:
Complete and utter NOMsense.
Image

User avatar
Jaysen
Posts: 6163
Joined: Mon Dec 17, 2007 4:00 am
Platform: Mac + Windows
Location: East-Be-Jesus-Nowhere SC, USA

Tue Aug 05, 2014 12:22 pm Post

I've read the definition of "manual" several times. I'm still not sure what I'm supposed to do with it...
Jaysen

I have a wife and 2 kids that I can only attribute to a wiggle, a giggle, and the realization that she was out of my league so I might as well be happy with her as a friend. 26 years marriage later, I can't imagine life without her. -Me 10/7/09

Image