What L4 features need better documentation?

Francis
Francis Member Posts: 3,936 ✭✭✭
edited November 2024 in English Forum

Logos is asking us for feedback as they are working on improving the existing L4 documentation. They suggested this thread for us to post the documentation needs we have noticed. Let's do it!

Francis

Comments

  • Francis
    Francis Member Posts: 3,936 ✭✭✭

    Data types that can be used in search:

    There is mention of the existence of data types in the help file, but I did not find an actual list of the ones that can be used as search parameters (such as "lang:" ; "mytag", etc).

    Along with that, a list of what's available under each data type would be useful too (for instance, for "lang:" , the actual language abbreviations such as "eng".

  • james hovie
    james hovie Member Posts: 1 ✭✭

    I agree with Francis, as I would love to have references light up in the open reference books to the text listing in my present link set. Something like ref:(LinkSetB) is Green. This would make finding the passage in, for example, BAGD much more smooth.

    Just an idea! 8*)

     

  • steve clark
    steve clark Member Posts: 3,591 ✭✭✭

    I would like to see screen images inside the help system. Most other programs help systems show screen or partial screen shots along with help text. This is really helpful when the help info is using terms for window or tab part and the user is unfamiliar with these terms. I like their videos, but some images in the help system would be worth a 1000 extra words.

    QLinks, Bibl2, LLR, Macros
    Dell Insp 17-5748, i5, 1.7 GHz, 8G RAM, win 8.1

  • Matt
    Matt Member Posts: 116 ✭✭

    OK, here's my first 2 of many cents.  As I work through and experiment with the program, I keep writing little notes to myself with questions that aren't answered in the help file.  First off, I would say this:

    In the sales literature, Logos is advertised as not coming with any documentation because it has all the help one would need in the program itself.  Please Logos, make this a reality!!

    OK, for starters:

    1. There should be illustrations: *lots* of them with screenshots that have arrows and balloons with text hanging off of them explaining the various things one sees on screen.  Did I mention there should be *lots* of screenshots?
    2. For each feature of the program, at a minimum, there should be at least one fully worked out example that covers all major options available in detail, and for the minor, less used options, at least a link to a glossary which defines the option and how it fits into the larger construct.

    That's it for now, thanks!

    Matt

    Specs:

    Windows 7 x64
    Quad Xeon 2.83 GHz x2
    16GB RAM
    Nvidia 285 GTX 1GB VRAM
    Logos 4.1 Platinum, SR-3, indexed

  • Damian McGrath
    Damian McGrath Member Posts: 3,050 ✭✭✭

    Matt said:

    There should be illustrations: *lots* of them with screenshots that have arrows and balloons with text hanging off of them explaining the various things one sees on screen.  Did I mention there should be *lots* of screenshots?

    Matt, absolutely agree. In the very first week of Beta testing, I asked for annotated images of the screens to assist us in talking about the program. To me this is basic. 

     

    Matt said:

    For each feature of the program, at a minimum, there should be at least one fully worked out example that covers all major options available in detail, and for the minor, less used options, at least a link to a glossary which defines the option and how it fits into the larger construct.

    Again, agreed. It should not be up to users to develop this basic documentation.

  • Harry Hahne
    Harry Hahne Member Posts: 766 ✭✭

    Syntax searches are very poorly documented and easy to make errors that produce wrong results or no results. Most options are not explained.

     

     

  • Greg Gray
    Greg Gray Member Posts: 136 ✭✭

    Syntax searches are very poorly documented and easy to make errors that produce wrong results or no results. Most options are not explained.

    a big +1 on this one.

  • steve clark
    steve clark Member Posts: 3,591 ✭✭✭

    P.S. to my earlier post.

    I noticed that Logos likes having the help in a narrow panel. If you wanted to keep this, you could add another dropdown menu entry for Manual Help and have it open a browser window which would allow for full screen view room to add the screenshots and other images within the help.

    QLinks, Bibl2, LLR, Macros
    Dell Insp 17-5748, i5, 1.7 GHz, 8G RAM, win 8.1

  • Roger King
    Roger King Member Posts: 105 ✭✭

    It would be great to have some documentation/videos about actually using these tools in a "real-world" scenario. I have tons of resources from the Platinum edition, but don't know how to use them effectively in a study. (ie. Word Study, BDAG, etc., etc., etc., etc.) This requires more than just a to use this tool, click here and type this explanation.

    Thanks!

  • Matt
    Matt Member Posts: 116 ✭✭

    If there's a way to make this topic be 'popular' or a sticky so that others will always see it (i.e. it will always be at the top of the topic listing in this forum) when they come to this forum (myself included), I think it would be benefiicial.

    Thanks,

    Matt

    Specs:

    Windows 7 x64
    Quad Xeon 2.83 GHz x2
    16GB RAM
    Nvidia 285 GTX 1GB VRAM
    Logos 4.1 Platinum, SR-3, indexed

  • Ken F Hill
    Ken F Hill Member Posts: 537 ✭✭✭

    Bible word study > preposition use.

  • John Fidel
    John Fidel MVP Posts: 3,461

    Do you have Greek Grammar Beyond the Basics? If so, go to Pg 358 or:

    libronixdls:jump|pos=LLS-AOL:0<DIV309>.188.0|res=LLS:46.20.1026

    I hope the links works, but if not you have the page # above.

     

     

  • Ken F Hill
    Ken F Hill Member Posts: 537 ✭✭✭

    JohnFidel said:

    Greek Grammar Beyond the Basics >

    Thanks.  I don't seem to have that resource.  I would hope the help would have some information on such a complex-looking tool.  Is there a search string I could use to see if I have anything equivalent to the section of the resource you mentioned?  I searched my library for "preposition use" and got 45 hits but they mostly were "preposition used" and not applicable -- (how do you force search to find strings exactly?)  The only exact match was for the help file but that just says there is a feature called 'preposition use' and nothing about how to use it.

    -ken

     

  • steve clark
    steve clark Member Posts: 3,591 ✭✭✭

    a screen shot showing all the various parts of the screen (with multiple tabs) showing arrows and the name of that screen/tab part. You could also put hyperlinks to help info on these parts.

     

    image

    QLinks, Bibl2, LLR, Macros
    Dell Insp 17-5748, i5, 1.7 GHz, 8G RAM, win 8.1

  • David Betts
    David Betts Member Posts: 99 ✭✭

    Layouts / Workspaces saved ON the machine.

    I want to re-open to where I was before when connection is not possible as in L3.

  • MJ. Smith
    MJ. Smith MVP Posts: 54,930

    While there is documentation on how to create objects, change and delete are frequently missing,

    Orthodox Bishop Alfeyev: "To be a theologian means to have experience of a personal encounter with God through prayer and worship."; Orthodox proverb: "We know where the Church is, we do not know where it is not."

  • steve clark
    steve clark Member Posts: 3,591 ✭✭✭

    QLinks, Bibl2, LLR, Macros
    Dell Insp 17-5748, i5, 1.7 GHz, 8G RAM, win 8.1

  • Harry Hahne
    Harry Hahne Member Posts: 766 ✭✭

    Many components of standard Guides are not explained, such as all aspects of the translation circle in the Word Study. I don't think it is right to expect a person to try to find an appropriate video on your web site, unless there is a link from the help. Even there, many things are not explained. Everything should be referred to in the help.

  • John Duffy
    John Duffy Member Posts: 591 ✭✭✭

    With the increased power of Logos 4, I find that my library-searching orientated use of the program leaves me using only a small potential of the features that are available.  Power-users on the other hand seem to be flying ahead using most features a lot.  They also seem to be the happiest users, while others seem to struggle to get some basic things working well.  Some of the problems are down to how the L4 works (e.g. Bibles not always opening in the pane where other Bibles are, or not being able to organise Notes, etc).  But documentation is a key issue that inhibits moving on from struggling with the basics.  Frustration with not being able to find suitable documentation can also sometimes give the impression that the program is not developed in certain areas when in fact it is.  It does not help also if the forums need to be searched, or a video watched in vain, to try to fill in knowledge gaps.

    In general, the Help documentation just seems too basic, just whetting our appetite but not giving the tools to do much more the little that is shown.  But then, where there is an entry, the detail is often missing as
    well e.g. how and when to use the Advanced option in Prioritisation.

    I agree that a picture paints a thousand words.  Words
    sometimes don't communicate the intended idea, even if they are
    technically accurate, as they sometimes only make sense once the
    concept  or significance of what is written is already understood. 

    Also, the How-To section seems unbelieveably small for such a sophisticated program as Logos 4.  For users who don't know How To use many of the advanced features, they are offered so little help. Macro Help rather than micro Help is what I'm thinking about - when and how to use the program's features to their max.  This would help bridge the gap between the power-users and those who use it for mainly basic navigation and searching through Bibles and books.  Or does this go beyond the program Help responsibility and move into the arena of training in original language instead?  I'm not sure.  But we should not need to pay for seminars (real-life or DVD) in order to find out how to do something that should be in the Help documentation. 

    I realise that this does not add to a list of items to put into the
    Help documentation, but it is an overall view instead, which could be lost if all the focus was on the details of adding particular bits of Help documentation.

    Generally, I'm not a fan of the existing 'minimalist' approach to the Help documentation.  But I am pleased that Logos is canvasing opinion on what users want to see changed or added.

  • MJ. Smith
    MJ. Smith MVP Posts: 54,930

    A chart of capabilities in L3 that have changed place or method in L4

    Orthodox Bishop Alfeyev: "To be a theologian means to have experience of a personal encounter with God through prayer and worship."; Orthodox proverb: "We know where the Church is, we do not know where it is not."