Page 1 of 1

Proposition for making a User Guide on qBittorrent (and a easy-to-read Wiki)

Posted: Thu Jul 10, 2014 2:59 am
by zeomal
Based on the end-dicussion of http://qbforums.shiki.hu/index.php/topic,2666.0.html, I have the following proposition(s):

a. Create a wiki page titled User Guide.
b. Populate under the page, under relevant headings, the following questions/topics and their answers:
  1. What is qBittorrent?
  2. Is qBittorrent free?
  3. Why use qBittorrent?
  4. Legality of qBittorrent
  5. History of qBittorrent
  6. Development builds
  7. The qBittorrent interface
  8. Description of the UI lock feature
  9. Is qBittorrent compatible with PeerGuardian?
  10. Various how-tos of qBittorrent, including, but not limited to, making qBittorrent the default torrent client, running it as a tracker (a link provided to know first time users that such a functionality exists), using the WebUI under a extension of popular web browsers...
  11. Non-technical explanation of Anonymous Mode
  12. Explanation of the colour codes
  13. How to use search engines and provide a list of them
  14. Labels and how to use them
  15. Using the default RSS reader
  16. Viewing the statistics
c. Add a specific page for explanation of various settings in the options of qB.
d. Remove a few questions from the current FAQ that are duplicated in the proposed User Guide, in addition to branching the FAQ into basic (for non-technical users) and advanced (for developers and others interested in the technical aspect of qBittorrent) flavours, with appropriate titles.

As you can probably make out, this is a first draft of the idea, and it is incomplete (it is missing a large number of possible questions, which will be populated later). I would request that more questions (with their answers) be contributed. These questions and answers must be preferably non-technical (no code based answers, except for Linux based queries, and where it is absolutely necessary). The technical questions can be added to a separate page in the Wiki. Added questions will be appended to the above list. The order of display of the questions will be done after enough questions are present.
Also, answers to a few (if not many, or all) of these questions are obvious, however, there are first time users and others who are not interested in finding the answers themselves, or just simply can't find time for this.
In addition, if you do not have any questions per se, comments would be appreciated as well.

Re: Proposition for making a User Guide on qBittorrent (and a easy-to-read Wiki)

Posted: Thu Jul 10, 2014 8:07 am
by hyperion1is
I think your project should be focused on User Guide and not FAQ. FAQ is different. If I have the time I will try to compile a FAQ to ease the adoption of qBt. I will have to research on this forum, the very first questions that have been addressed by users. Like what was the first question (post) of a user on this forum, except the Welcome section, ofcourse.
Maybe a Newbie sub-forum here would be a plus. Anyway to answers the above questions we would have to research the Documentation and the topic on this forum, but even so, we would need assistance from the "gurus" :)
PS. You let out the paus/stop issue on your list.

Re: Proposition for making a User Guide on qBittorrent (and a easy-to-read Wiki)

Posted: Thu Jul 10, 2014 11:13 am
by Nemo
Its a nice idea to have something like this. Alot of information is spread over the internet and questions that are being answered several times and still being asked cause the new users appearantly can't find the answers that they need, or too lazy to search. Instead we could have all the information at one place and link to there.

Re: Proposition for making a User Guide on qBittorrent (and a easy-to-read Wiki)

Posted: Thu Jul 10, 2014 11:53 am
by sledgehammer_999
I'll throw another idea. You could start documenting the settings per page. (although I might change some of the them for 3.2.0, you should focus on 3.1.x for now).

Re: Proposition for making a User Guide on qBittorrent (and a easy-to-read Wiki)

Posted: Thu Jul 10, 2014 11:55 am
by zeomal
This Pause/Stop button "issue" is what resulted in me wanting to make a User Guide for qBittorrent in the first place. I intend to add it under the introduction to the qBittorrent interface. In addition, it's a very valid doubt (that even I had for a few days, until I discovered the purpose behind it), for first time users, especially those from µTorrent. Most of them would be stumped by the absence of the stop button, so a valid explanation might just do wonders.

As to the answers to the already existing questions, I have them ready ;D. Of course, they would have to be checked by the gurus for correctness, but some of these answers have been copied from (with a few modifications) the existing FAQ. The reason I want these questions removed from the FAQ is because these shouldn't have been in the FAQ in the first place.

Yes. This project is aimed to be focused on making a user guide (the questions have to be rephrased to topics, I agree), but some of the topics are already covered in the FAQ. This will result in unnecessary duplication, and might even result in inconsistency (I intend to take care of only the user-manual, with help from whoever wants to). That is the reason I want a few questions to be removed from the FAQ.

In addition, your idea of researching in the forum is nice. That should provide a nice starting point for actually required newbie questions.

[quote="Nemo"]
Its a nice idea to have something like this.
[/quote]
Thank you, Nemo.

[quote="sledgehammer_999"]
I'll throw another idea. You could start documenting the settings per page.
[/quote]
Thank you. On it. This will take some time, and I will require some help with the advanced settings, not to mention the WebUI (I still have very little idea of what this is, since I have never shown any interest in using it).

Re: Proposition for making a User Guide on qBittorrent (and a easy-to-read Wiki)

Posted: Thu Jul 10, 2014 2:10 pm
by zeomal
The documentation of settings is now complete (the first draft). However, I would like help with the following:
  1. How the Desktop options in Behaviour change in Linux and Mac distributions (with explanations for newbie users, please).
  2. How to use the email notification feature, or a link to defining terms such as SMTP for a casual user.
  3. An explanation on how to use the Run an external program upon torrent completion.
  4. An explanation of the various options under Global Rate Limits.
  5. A simple explanation of slow torrents.
  6. What to type in Web UI
I would also like to know whether it'll be a good idea to include information for advanced settings as well.
The documentation for settings is given in the attachments below in a text file format. Use the MediaWiki edit mode on GitHub for accurate formatting of the data in it. The various settings are separated by >> followed by the classification.

Re: Proposition for making a User Guide on qBittorrent (and a easy-to-read Wiki)

Posted: Sun Jul 20, 2014 5:00 pm
by zeomal
Wiki on settings has been published.

Issues to note:

  1. A link to Kickass Torrents Forum has been provided. This was done because it was the best tutorial that was available. If there are any objections, feel free to remove it, preferably after providing a valid, viable alternative. There is nothing illegal in linking to a forum on Kickass Torrents, as far as I know.
  2. There is NO EXPLANATION for the advanced options, and only a link to the Web UI details.

Re: Proposition for making a User Guide on qBittorrent (and a easy-to-read Wiki)

Posted: Fri Dec 22, 2017 2:24 am
by Geneset
I have also find a good review of Kickass alternative: http://www.videoconverterfactory.com/tips/kickass-alternative.html
Hope it can help you guys who want to try another good tracker like it.