JDownloader Community - Appwork GmbH
 

Reply
 
Thread Tools Display Modes
  #1  
Old 06.11.2010, 17:39
fma16's Avatar
fma16 fma16 is offline
Support Français (inactive)
 
Join Date: Jul 2010
Location: Marseille, FRANCE
Posts: 1,399
Default Create User Guide for JD

I'M LOOKING FOR SOMEONE WHO ARE ON LINUX AND CAN HELP ME. IF YOU WANT TO ADD YOUR PARTICIPATION IN THIS PROJECT, PLEASE PM ME!
Hi everyone.
As you know, JD is not very JD comfortable to use and many people complain about that. That's why I thought that we could create a user guide in .pdf, for example, included in JD. I don't know if someone talks about that, but I want to know your opinion and if you agree to help me to create this.
Thank you in advance.
Greetings, Fma16

Summary :
1.Téléchargement et Installation (Downloading and Installation)
1.1. Téléchargement (Downloading)
1.2. Installation Windows (Windows Installation)
1.3. Installation Macintosh (Macintosh Installation)
1.4. Installation Linux (Linux Installation)
2. Utiliser JDownloader (How to Use JDownloader)
2.1. Comment ajouter des liens? (How to add links?)
...

EDIT : I add the beggining of the user guide, in french. Feel free to comment it.

Changelog :
Alpha Version:
0.1.00 : Page 1 & Page 2
0.1.01 : Modify the background in the Page 1 (Recommendation : Drbits)
0.1.02 : Modifiy background in the Page 2.
0.2.00 : Add page 3 and 4. Add .pdf version.
0.2.01 : Modify presentation. Add addons chapter
Download :
**External links are only visible to Supporters**
__________________
MacOS 10.6.8 on iMac 2007 Intel 2.16Ghz 3Go RAM
Lubuntu 10.04LTS on a crappy Gericom Laptop
C'est toujours mieux de lire certains articles du forum avant de poster:
Projet de guide d'utilisation pour JD / Project for JD User Guide
Spoiler:
Quote:
Originally Posted by Jiaz View Post
Next major version is...already visible at the horizon

**External links are only visible to Supporters**

Last edited by fma16; 04.08.2011 at 22:41. Reason: Add Version 0.2.01 - Modify Download link
Reply With Quote
  #2  
Old 07.11.2010, 11:32
remi remi is offline
JD Legend
 
Join Date: Mar 2009
Location: Absurdistan
Posts: 16,237
Cool

A .pdf file is a good format for distribution of bank account information and white papers, but not adapted to collaborative work like documentation authoring. Wikis are better for that. I would recommend using a semantic wiki.

Making manuals is a risky business when a product hasn't attained a stable HMI. I'm not a tester but what I read in the Nightly forum suggests that you'll need to rewrite a lot when the next release of jD finally comes.

By reading the posts/threads discussing the problem, you'll also understand which members might be interested in participating in such an effort. drbits, gweilo, remi, madmax2 are a few names. drbits likes writing books and he has a fluent style.

There have been several discussions concerning manuals and other types of documentation. Don't be surprised by some of the thread titles, because the discussions started after complaints were expressed about the lack thereof. Here are a few :-

- "Sort files by size etc."; read post #17 until the end of the thread

- "Ignore certain file types"; read post #35 until the end of the thread

- "Documentation strategies"

My current conclusions from these past discussions are that :-

1) Usability and documentation are each other's opposites. The higher the usability level of a software the less questions a customer will have about the software. Simply applying standard HMI (Human Machine Interface) recommendations could enhance the usability considerably. drbits proposed/discussed them several times.

2) Writing documentation can be enforced by including it in the software development life cycle; this will increase the quality of the software because a review cycle will detect design and usability issues; simple, workflow based procedures will make documentation almost unnecessary

3) Specialised, talented people can be found who love writing documentation (and dislike programming);

4) The importance of the .loc files. There are translations for over 40 languages now and you don't want to translate your manual word by word, sentence by sentence to 40 other languages. Documentation should be multi-lingual. A semantic approach and reuse of the .loc file contents is recommendable. Using hooks in the software are a means of testing the completeness of the documentation. The .loc files can also be used to control the "completeness" of the manual.

5) Almost all issues, questions, problems and requirements can be found in the forums. A good search mechanism that can be used by all members is missing. I suggested a semantic search/query mechanism. A good semantic search engine might be the cheapest solution for people who want assistance with the use of the jD software.
Reply With Quote
  #3  
Old 07.11.2010, 15:34
fma16's Avatar
fma16 fma16 is offline
Support Français (inactive)
 
Join Date: Jul 2010
Location: Marseille, FRANCE
Posts: 1,399
Default

Quote:
Originally Posted by remi View Post
A .pdf file is a good format for distribution of bank account information and white papers, but not adapted to collaborative work like documentation authoring. Wikis are better for that. I would recommend using a semantic wiki.
I explain my goal : I want to create a file who gonna help news users of JD when they begin to use the software (How to install, add links, add accounts, ...). Simply, i want to put "Beginner's guide to downloading with JDownloader " in a nice .pdf. After do this, maybe I will create a "wiki" like you say, or a complete user guide with screenshots and procedure though wiki links, who will be updated more frequently.

Quote:
Originally Posted by remi View Post
Making manuals is a risky business when a product hasn't attained a stable HMI. I'm not a tester but what I read in the Nightly forum suggests that you'll need to rewrite a lot when the next release of jD finally comes.
It's the game. If one thinks like that, nobody does anything.

Quote:
Originally Posted by remi View Post
By reading the posts/threads discussing the problem, you'll also understand which members might be interested in participating in such an effort. drbits, gweilo, remi, madmax2 are a few names. drbits likes writing books and he has a fluent style.

There have been several discussions concerning manuals and other types of documentation. Don't be surprised by some of the thread titles, because the discussions started after complaints were expressed about the lack thereof. Here are a few :-

- "Sort files by size etc."; read post #17 until the end of the thread

- "Ignore certain file types"; read post #35 until the end of the thread

- "Documentation strategies"
Thanks!
That's why I created this thread. I want everyone to help me.
Thanks for the links, I gonna read them.

Quote:
Originally Posted by remi View Post
My current conclusions from these past discussions are that :-

1) Usability and documentation are each other's opposites. The higher the usability level of a software the less questions a customer will have about the software. Simply applying standard HMI (Human Machine Interface) recommendations could enhance the usability considerably. drbits proposed/discussed them several times.
Agree with you. But this is not the case for JD. So I think user guide is a good "temporary" answer.

Quote:
Originally Posted by remi View Post
2) Writing documentation can be enforced by including it in the software development life cycle; this will increase the quality of the software because a review cycle will detect design and usability issues; simple, workflow based procedures will make documentation almost unnecessary
Why not.

Quote:
Originally Posted by remi View Post
3) Specialised, talented people can be found who love writing documentation (and dislike programming);
I love JD and I want to add something to thank creators, developers and all the community. I've found that.

Quote:
Originally Posted by remi View Post
4) The importance of the .loc files. There are translations for over 40 languages now and you don't want to translate your manual word by word, sentence by sentence to 40 other languages. Documentation should be multi-lingual. A semantic approach and reuse of the .loc file contents is recommendable. Using hooks in the software are a means of testing the completeness of the documentation. The .loc files can also be used to control the "completeness" of the manual.
Yeah, it's true. I gonna do the French and the English documentation, for translation, I rely on community involvement.
__________________
MacOS 10.6.8 on iMac 2007 Intel 2.16Ghz 3Go RAM
Lubuntu 10.04LTS on a crappy Gericom Laptop
C'est toujours mieux de lire certains articles du forum avant de poster:
Projet de guide d'utilisation pour JD / Project for JD User Guide
Spoiler:
Quote:
Originally Posted by Jiaz View Post
Next major version is...already visible at the horizon

**External links are only visible to Supporters**
Reply With Quote
  #4  
Old 07.11.2010, 18:59
drbits's Avatar
drbits drbits is offline
JD English Support (inactive)
 
Join Date: Sep 2009
Location: Physically in Los Angeles, CA, USA
Posts: 4,437
Default

I saw your two JPGs yesterday (my time).

In terms of appearance, it is great. My one suggestion is to make the background copy of the logo almost a watermark. It is two or three times to visible and hides your text. Remember, most people will view this is Adobe Reader, not print it.

I would like to suggest that you put your outline (table of contents - Table des matières) in the thread here.

I cannot read French, I can only skim it for the general meaning, but the content it looks good. Is there a new user you can ask to read it?

I would also create a thread in which the first message is the text of the content, and update it as you go.

If this were intended for US readers, I would use the MS Word grammar checker to check for "Grade Level" and I almost always aim for 8th or 9th grade reading level (the average adult reading level is 9th to 10th grade here).

Last edited by drbits; 07.11.2010 at 19:06.
Reply With Quote
  #5  
Old 07.11.2010, 19:50
fma16's Avatar
fma16 fma16 is offline
Support Français (inactive)
 
Join Date: Jul 2010
Location: Marseille, FRANCE
Posts: 1,399
Default

Quote:
Originally Posted by drbits View Post
In terms of appearance, it is great. My one suggestion is to make the background copy of the logo almost a watermark. It is two or three times to visible and hides your text. Remember, most people will view this is Adobe Reader, not print it.
I modify the page 1, tell me if it's better : "http://www.hostingpics.net/viewer.php?id=376925page1.jpg"

Quote:
Originally Posted by drbits View Post
I would like to suggest that you put your outline (table of contents - Table des matières) in the thread here.
I gonna do it now. Thanks for the advice.

Quote:
Originally Posted by drbits View Post
I cannot read French, I can only skim it for the general meaning, but the content it looks good. Is there a new user you can ask to read it?
There are more people who download this in the French tread, but I didn't get any suggestion (apart yours and remi). I think that we must wait.

Quote:
Originally Posted by drbits View Post
I would also create a thread in which the first message is the text of the content, and update it as you go.
Remi advised me to do something like that. It's a great idea and i'm gonna do this.

Quote:
Originally Posted by drbits View Post
If this were intended for US readers, I would use the MS Word grammar checker to check for "Grade Level" and I almost always aim for 8th or 9th grade reading level (the average adult reading level is 9th to 10th grade here).
It will
Thanks for the advice!

@everyone
I remind you that if you have a file text, some screenshots, or anything that could help me, you can send it by PM me
__________________
MacOS 10.6.8 on iMac 2007 Intel 2.16Ghz 3Go RAM
Lubuntu 10.04LTS on a crappy Gericom Laptop
C'est toujours mieux de lire certains articles du forum avant de poster:
Projet de guide d'utilisation pour JD / Project for JD User Guide
Spoiler:
Quote:
Originally Posted by Jiaz View Post
Next major version is...already visible at the horizon

**External links are only visible to Supporters**
Reply With Quote
  #6  
Old 07.11.2010, 20:46
drbits's Avatar
drbits drbits is offline
JD English Support (inactive)
 
Join Date: Sep 2009
Location: Physically in Los Angeles, CA, USA
Posts: 4,437
Default

The background is better. I can now see the text on top of it.
Reply With Quote
  #7  
Old 07.11.2010, 22:20
fma16's Avatar
fma16 fma16 is offline
Support Français (inactive)
 
Join Date: Jul 2010
Location: Marseille, FRANCE
Posts: 1,399
Default

I add the 0.1.01 update. Download it!
__________________
MacOS 10.6.8 on iMac 2007 Intel 2.16Ghz 3Go RAM
Lubuntu 10.04LTS on a crappy Gericom Laptop
C'est toujours mieux de lire certains articles du forum avant de poster:
Projet de guide d'utilisation pour JD / Project for JD User Guide
Spoiler:
Quote:
Originally Posted by Jiaz View Post
Next major version is...already visible at the horizon

**External links are only visible to Supporters**
Reply With Quote
  #8  
Old 08.11.2010, 02:49
v12hcmf v12hcmf is offline
Vacuum Cleaner
 
Join Date: Jun 2009
Posts: 16
Question Since when did not including Updated manuals become Okay?

Thank god for this! I totally agree and will try and help also; I'm tired of having to endless search forums or _oogle to find answers that should be clearly explained and written in a 1 file guide. Now I'm not trying to offend the creators/helpers, but eventually "search/read the forum" becomes redundant, mundane and with 100s of posts, it's become unorganized. I'd rather hear "RTFM," I WOULD if there was one lmfao.

Which brings me to a side issue; JDownFF is the firefox addon, which barely has any listed/updated information about it. The newest FF release (3.6) says my JDownFF addon isn't compatible, I've yet to find any information about it being compatible with Ver3.6—WHY NOT? This makes no sense to me to have addons, but not have info readily available about its future compatibility; forgive me if there is info on here about it, but Ive long been searching in advance and found little.

That example above is exactly why having a manual is crucial... Some of us don't have 24/7 access to the forums/internet, ahem.

Thanks to all who support and develop this product!

-V
Reply With Quote
  #9  
Old 08.11.2010, 11:37
remi remi is offline
JD Legend
 
Join Date: Mar 2009
Location: Absurdistan
Posts: 16,237
Default

Please read "Firefox Addon" (http://jdownloader.net:8081/knowledge/wiki/addons/list/firefox-addon").

What you refer to is typical for the "add-on" culture. I call it "add-onitis". It's almost by definition that add-ons are created, used for a little while, and finally abandoned by lack of documentation and updates. They are considered extensions that aren't essential to the application they were developed for. If they would be essential they would be integrated into the application and this problem wouldn't exist.
They get out of sync with the application they were supposed to enhance. That's why they're almost always the most important source of security threats. By their nature they don't take advantage of the security precautions that are part of the main application.
My best example is Flash. I hope the most important features of Flash will soon be integrated in my browser so that I can finally view some sites.
Reply With Quote
  #10  
Old 08.11.2010, 23:11
fma16's Avatar
fma16 fma16 is offline
Support Français (inactive)
 
Join Date: Jul 2010
Location: Marseille, FRANCE
Posts: 1,399
Default

Upgrade to the 0.1.02!

@v12hcmf
Thanks!
__________________
MacOS 10.6.8 on iMac 2007 Intel 2.16Ghz 3Go RAM
Lubuntu 10.04LTS on a crappy Gericom Laptop
C'est toujours mieux de lire certains articles du forum avant de poster:
Projet de guide d'utilisation pour JD / Project for JD User Guide
Spoiler:
Quote:
Originally Posted by Jiaz View Post
Next major version is...already visible at the horizon

**External links are only visible to Supporters**
Reply With Quote
  #11  
Old 10.11.2010, 22:46
fma16's Avatar
fma16 fma16 is offline
Support Français (inactive)
 
Join Date: Jul 2010
Location: Marseille, FRANCE
Posts: 1,399
Default

I Upload the Version 0.2.00. Download it!
I'M LOOKING FOR SOMEONE WHO ARE ON LINUX AND CAN HELP ME. IF YOU WANT TO ADD YOUR PARTICIPATION IN THIS PROJECT, PLEASE PM ME!
__________________
MacOS 10.6.8 on iMac 2007 Intel 2.16Ghz 3Go RAM
Lubuntu 10.04LTS on a crappy Gericom Laptop
C'est toujours mieux de lire certains articles du forum avant de poster:
Projet de guide d'utilisation pour JD / Project for JD User Guide
Spoiler:
Quote:
Originally Posted by Jiaz View Post
Next major version is...already visible at the horizon

**External links are only visible to Supporters**
Reply With Quote
  #12  
Old 11.11.2010, 21:20
coalado's Avatar
coalado coalado is offline
JD Manager
 
Join Date: Feb 2009
Posts: 1,977
Default

Nice done.

But I would really suggest you to use (for example) http://en.wikipedia.org/wiki/TeX . And our svn server, so that several people can work on the document.
__________________
Reply With Quote
  #13  
Old 11.11.2010, 21:40
fma16's Avatar
fma16 fma16 is offline
Support Français (inactive)
 
Join Date: Jul 2010
Location: Marseille, FRANCE
Posts: 1,399
Default

I'm talking about this with isandar, my partner. We use Photoshop to do it until now. I'm gonna see the advantages of TuX Tomorrow (1,5Go with a 512 kbps, it's take much time).
What do you suggest for the svn server? I don't understand? You want that I publish the user guide on it?
__________________
MacOS 10.6.8 on iMac 2007 Intel 2.16Ghz 3Go RAM
Lubuntu 10.04LTS on a crappy Gericom Laptop
C'est toujours mieux de lire certains articles du forum avant de poster:
Projet de guide d'utilisation pour JD / Project for JD User Guide
Spoiler:
Quote:
Originally Posted by Jiaz View Post
Next major version is...already visible at the horizon

**External links are only visible to Supporters**
Reply With Quote
  #14  
Old 12.11.2010, 19:26
fma16's Avatar
fma16 fma16 is offline
Support Français (inactive)
 
Join Date: Jul 2010
Location: Marseille, FRANCE
Posts: 1,399
Default

I download the Mac version and it's pretty difficult. I don't understand anything! I'm gonna seek some help but i'm not sure that I gonna use it!
__________________
MacOS 10.6.8 on iMac 2007 Intel 2.16Ghz 3Go RAM
Lubuntu 10.04LTS on a crappy Gericom Laptop
C'est toujours mieux de lire certains articles du forum avant de poster:
Projet de guide d'utilisation pour JD / Project for JD User Guide
Spoiler:
Quote:
Originally Posted by Jiaz View Post
Next major version is...already visible at the horizon

**External links are only visible to Supporters**
Reply With Quote
  #15  
Old 13.11.2010, 00:05
Botzi's Avatar
Botzi Botzi is offline
JD-Team
 
Join Date: Feb 2009
Location: #jdownloader@freenode.net
Posts: 357
Default

tex is a typesetting program. It's like HTML/CSS just for documents.

if you need help with linux just ask me.
Reply With Quote
  #16  
Old 13.11.2010, 06:18
fma16's Avatar
fma16 fma16 is offline
Support Français (inactive)
 
Join Date: Jul 2010
Location: Marseille, FRANCE
Posts: 1,399
Default

I'm gonna try some tutorial this week-end
Actually, I need some screenshoots and description for how install JD in Linux. If you can help me, it's would be great!
__________________
MacOS 10.6.8 on iMac 2007 Intel 2.16Ghz 3Go RAM
Lubuntu 10.04LTS on a crappy Gericom Laptop
C'est toujours mieux de lire certains articles du forum avant de poster:
Projet de guide d'utilisation pour JD / Project for JD User Guide
Spoiler:
Quote:
Originally Posted by Jiaz View Post
Next major version is...already visible at the horizon

**External links are only visible to Supporters**
Reply With Quote
  #17  
Old 13.11.2010, 23:15
Botzi's Avatar
Botzi Botzi is offline
JD-Team
 
Join Date: Feb 2009
Location: #jdownloader@freenode.net
Posts: 357
Default

There are 3 ways to run JD on linux.
  1. An deb for Ubuntu from launchpad. Is the only installable version.
  2. The normal multi OS version.
  3. An special bash script that downloads jd and starts it. A detailed description is in the script.

All 3 available in the download section.
I think there is no need for a screenshot because 1), 3) are scripts with no gui and 1) is a normal deb that will be installed with apt.
Reply With Quote
  #18  
Old 14.11.2010, 04:07
drbits's Avatar
drbits drbits is offline
JD English Support (inactive)
 
Join Date: Sep 2009
Location: Physically in Los Angeles, CA, USA
Posts: 4,437
Default

TeX is a real typesetting system. It is very different from using Adobe tools. You write a text file and insert tags to control the formatting. Much of the formatting is in macros (you normally tell TeX to load a style near the top of the file). TeX files are portable, while Adobe Indesign files (the closest equivalent in the Adobe line) are not.

I last used TeX 25 years ago. Since then, people have written tools to help write in it (I used EMACS).

A major advantage of TeX is that as text files, the master documents and chapters are suitable for storage in a version control system like Subversion. Chapters can be checked-in and checked-out as needed.

Another advantage is that text can be translated, while the formatting is left the same.
_______________________________

For SVN, follow the instructions under "Source" in the JD Download page. This will include installing Eclipse and loading the sources for JD and a package it needs from a different site. Eclipse contains a Subversion client for accessing the SVN database. This will allow you to see the code if you need it, but also to adjust the fr.loc (French Localization file) for JD.

PM scr4ve for an SVN account that allows you to submit Bug Tickets (as a Supporter) and to save your Documents, images, and other parts of your work to a section of the Version Control. Make sure to include translator privileges in your request.
Reply With Quote
Reply

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

All times are GMT +2. The time now is 01:41.
Provided By AppWork GmbH | Privacy | Imprint
Parts of the Design are used from Kirsch designed by Andrew & Austin
Powered by vBulletin® Version 3.8.9
Copyright ©2000 - 2017, Jelsoft Enterprises Ltd.