Documentation!!!

I am looking for a complete document on all the features of IntelliJ. I am tired of stumbling upon these features and thinking "wow i could have used this last week". I have read the overview but it seems like the help document is really the in-depth coverage I am looking for. Does anyone know where I can get a pdf or some printable version of it? Is there any other documents that you would suggest reading? I know I can read the help online, and even print each individual page but I would rather print the entire thing and work through it like a book.

19 comments
Comment actions Permalink

I have been asking abut this for a year.
JF

"charles decroes" <intellij@decroes.com> wrote in message
news:7213329.1039721107662.JavaMail.jrun@is.intellij.net...

I am looking for a complete document on all the features of IntelliJ. I

am tired of stumbling upon these features and thinking "wow i could have
used this last week". I have read the overview but it seems like the help
document is really the in-depth coverage I am looking for. Does anyone know
where I can get a pdf or some printable version of it? Is there any other
documents that you would suggest reading? I know I can read the help
online, and even print each individual page but I would rather print the
entire thing and work through it like a book.


0
Comment actions Permalink


It doesn't seem to exist. I ended up just paging through the online help, once that existed. Tedious, but I really did learn a lot.

--Dave

0
Comment actions Permalink

it's a shame that they haven't turned the online help into a pdf yet. it seems like it would be pretty easy to do and really benefit a lot of customers.

0
Comment actions Permalink

It's really a shame that there is no comprehensive user guide. IMHO, this
is going to become a much greater deficiency in IDEA as time goes by and
the feature set grows. You'd think that JetBrains, being familiar with
agile methods, would realize that building up debt, in this case
documentation debt, is a bad thing, and the debt will be due with interest
some day.

Paul

0
Comment actions Permalink

Exactly...at least give us an easy way to print it ourselves!
JF

"charles decroes" <intellij@decroes.com> wrote in message
news:5245931.1039896821060.JavaMail.javamailuser@localhost...

it's a shame that they haven't turned the online help into a pdf yet. it

seems like it would be pretty easy to do and really benefit a lot of
customers.


0
Comment actions Permalink

I totally agree. It's the same thing when everyone used the spiral methodology, at some point you have to stop and document what you have. We use to stop every year or so and update our requirements doc just so we knew what all we had done.

0
Comment actions Permalink

Maybe its a good opportunity for a 3rd party to step up and put out a good manual or cookbook kinda thing.

0
Comment actions Permalink

"charles decroes" <intellij@decroes.com> wrote in
message news:7213329.1039721107662.JavaMail.jrun@is.intellij.net...
I am looking for a complete document on all the features of IntelliJ. I

am tired of

stumbling upon these features and thinking "wow i could have used this

last week".

I have read the overview but it seems like the help document is really

the in-depth

coverage I am looking for. Does anyone know where I can get a pdf or some

printable

version of it? Is there any other documents that you would suggest

reading? I know

I can read the help online, and even print each individual page but I

would rather print

the entire thing and work through it like a book.


The situation is even worse: help file is not complete and has a lot of
misspellings and sometimes just bad english ("suitable" is not english and
barely an american english). I am not saying that my english is perfect, but
I can see errors in the others' documents. I did not read the whole help
file, but here is one example: intentions. "Editing files/Indended Actions"
does not describe how to turn intention back on. The list of intentions is
incomplete.

As a general help file drawback: the search option within the help page
(ctrl-f or something) is unavailable, so for example I cannot locate needed
intention in the intention list.

The help text is written in a slow book manner ("when you have a lot of
code, mistakes are unavoidable..."). Hey, this is not a book which I read
over the dinner, this is an online help file! I know that I make mistakes. I
know that IDEA can assist. I know "for instance". Make it short, clean, and
complete. Mean business!

Here is how I would rewrite the aforementioned section about intentions (not
polished, but gives the idea):

*******
Intention Action inline code wizard helps to maintain:

  • the uniform code style;

  • adherence to Java language, J2EE, corporate and personal coding

standards;

  • code consistency throughout the project


Intention Action is visually identified in a source code pane as a yellow
("turned on") light bulb on the left margin of the code pane. Intention
Action light bulb is displayed when caret is positioned on the suspicious
token.

To open the Intention Actions list:

  • mouse over the light bulb and open Intention Action drop-down menu from

the Inline Wizard window (To the readers: "Inline Wizard window" or
"Autocorrect window" or "Smartedit toolbox" should be defined in editor
cotrols' description in the other part of help file. Also, bullets for "do
this AND then this AND then this" and for "do this OR this" should be
visually different).
- OR -

  • press Alt-Enter


To apply the Intention select appropriate action from the Intention Action
list.

To turn the particular Intention Action rule off click on the lightbulb on
the left of the rule. The lighbulb becomes gray ("turned off").

To turn on the intention press ...

To turn off all Intention Actions press ...
********

And so on.

Cheers,
Michael J.



0
Comment actions Permalink

BTW, why class importing should be the special case of Intention Action? I
understand, that it was implemented in earlier versions of IDEA and Intellij
guys do not want to rewrite this piece of code, but for the sake of
consistency and ease of use it should be rewritten. I will post it to the
Tracker.


0
Comment actions Permalink

Michael Jouravlev wrote:

misspellings and sometimes just bad english ("suitable" is not english and
barely an american english). I am not saying that my english is perfect, but


http://dictionary.reference.com/search?q=suitable

But, yes, I would tend to agree with you. The online help seems out of date.

Ciao,
Gordon

--
Gordon Tyler
Software Developer, R&D
Sitraka (now part of Quest Software)
"Performance is Mission Critical"

0
Comment actions Permalink

"charles decroes" <intellij@decroes.com> wrote in
message

...bad english ("suitable" is not english and
barely an american english)...


I agree with what you're saying but:
In what way is "suitable" not English?

Vince.

0
Comment actions Permalink

Gentleman:

Where is "suitable" being used? As an American, seems like a perfectly good
English word to me....

Some of you feel that the documentation is lacking -- can you please be more
specific as to what you'd like to see? We have many different skill level
users using IDEA, and we try to accommodate everyone; however, if we don't
have specific feedback, then we don't know what documentation to prioritize.
There will be a "Quick Start" guide coming out soon, and this will address
many of the basic features to get you up and going. But, what specific
would you like to see.

As for misspellings -- it happens. Please, when you say "there are
misspellings," can you please tell us WHERE, so we can fix them?

And finally, if you have any questions, concerns, or complaints about
documentation, please post them in: jetbrains.intellij.documentation -- this
is why we have it.




"Michael Jouravlev" <mikus@mail.ru> wrote in message
news:atnqcp$j8c$1@is.intellij.net...

"charles decroes" <intellij@decroes.com> wrote in
message news:7213329.1039721107662.JavaMail.jrun@is.intellij.net...
I am looking for a complete document on all the features of IntelliJ. I

am tired of

stumbling upon these features and thinking "wow i could have used this

last week".

I have read the overview but it seems like the help document is really

the in-depth

coverage I am looking for. Does anyone know where I can get a pdf or

some

printable

version of it? Is there any other documents that you would suggest

reading? I know

I can read the help online, and even print each individual page but I

would rather print

the entire thing and work through it like a book.

>

The situation is even worse: help file is not complete and has a lot of
misspellings and sometimes just bad english ("suitable" is not english and
barely an american english). I am not saying that my english is perfect,

but

I can see errors in the others' documents. I did not read the whole help
file, but here is one example: intentions. "Editing files/Indended

Actions"

does not describe how to turn intention back on. The list of intentions is
incomplete.

>

As a general help file drawback: the search option within the help page
(ctrl-f or something) is unavailable, so for example I cannot locate

needed

intention in the intention list.

>

The help text is written in a slow book manner ("when you have a lot of
code, mistakes are unavoidable..."). Hey, this is not a book which I read
over the dinner, this is an online help file! I know that I make mistakes.

I

know that IDEA can assist. I know "for instance". Make it short, clean,

and

complete. Mean business!

>

Here is how I would rewrite the aforementioned section about intentions

(not

polished, but gives the idea):

>

*******
Intention Action inline code wizard helps to maintain:

  • the uniform code style;

  • adherence to Java language, J2EE, corporate and personal coding

standards;

  • code consistency throughout the project

>

Intention Action is visually identified in a source code pane as a yellow
("turned on") light bulb on the left margin of the code pane. Intention
Action light bulb is displayed when caret is positioned on the suspicious
token.

>

To open the Intention Actions list:

  • mouse over the light bulb and open Intention Action drop-down menu

from

the Inline Wizard window (To the readers: "Inline Wizard window" or
"Autocorrect window" or "Smartedit toolbox" should be defined in editor
cotrols' description in the other part of help file. Also, bullets for "do
this AND then this AND then this" and for "do this OR this" should be
visually different).
- OR -

  • press Alt-Enter

>

To apply the Intention select appropriate action from the Intention Action
list.

>

To turn the particular Intention Action rule off click on the lightbulb on
the left of the rule. The lighbulb becomes gray ("turned off").

>

To turn on the intention press ...

>

To turn off all Intention Actions press ...

>

And so on.

>

Cheers,
Michael J.

>
>
>


0
Comment actions Permalink

Honestly, I would LIKE (more like LOVE) and will pay for, a printed version of the documentation. Not because it's pretty, but sometimes when you're laying back 'relaxing' and want something to skim through, and don't want to be on your machine, it's always nice to have full docs and look things up and read about it.

This IS the ONLY piece that has annoyed me about IDEA. I'll pay the price for extra docs any day, heck even sell them to me separately so other folks who don't care don't have to have them.

I want to see everything with examples and tutorials on how to use the various features.

I would LOVE to have a cheat sheet for all the command shortcuts for IDEA that I can stick next to my screen so I can refer to it. Come to think of it, maybe I will spend a little time and create one and post it on the org wiki site... I'm SURE LOTS of people can use it.

R

0
Comment actions Permalink

If you post it on the wiki site, you should post it on the same page with
the other cheat sheets for command shortcuts
(http://www.intellij.org/twiki/bin/view/Main/IdeaReferenceCard).

"Robert S. Sfeir" <sfeir@mail.nih.gov> wrote in message
news:486722.1040235593449.JavaMail.jrun@is.intellij.net...

I would LOVE to have a cheat sheet for all the command shortcuts for IDEA

that I can stick next to my screen so I can refer to it. Come to think of
it, maybe I will spend a little time and create one and post it on the org
wiki site... I'm SURE LOTS of people can use it.


0
Comment actions Permalink

just to clarify, charles decroes said nothing about the word suitable as your previous post looks. Michael Jouravlev wrote the reply on the word suitable. I just want some decent documentation. I don't care if it has mispellings and broken english as long as it's somewhat complete and printable.

0
Comment actions Permalink

david,
I, and I think "we", want printed or printable documentation. The online help is ok but difficult to print because you have to print a page at a time. If we could get a pdf, rtf or something similar it would help out a lot.

0
Comment actions Permalink

And finally, if you have any questions, concerns, or
complaints about
documentation, please post them in:
jetbrains.intellij.documentation -- this
is why we have it.


For those miserable of us, who are sitting behind firewalls and having no access to NNTP servers, please, create a separate web forum, where all documentation issues to be discussed (this forum may be mapped to the newsgroup and vice versa).

I would like to contribute to documentation, but some stable communication channel has to be established first.

0
Comment actions Permalink

david
is there any chance we can get a printable version of the online help?

0

Please sign in to leave a comment.