IntelliJ User Documentation in printable format?

Hi,

As IntelliJ 6.0 is in beta stage right now, I want to raise the question again: Will - finally - a user documentation in a printbable format (like PDF) be provided in the final release? In a previous thread, JetBrains stated that documentation will be strongly improved in IntelliJ 6.0. Can somebody elaborate, what is planned?

In my opinion, documentation should also be beta tested, in order to eliminate mistakes or to get feedback, where the documents need improvements or what is missing.

The reason I ask for printable documents is that I do not like to read long documents on screen and prefer to read docs when I am not in the office or at the computer.

Kind regards

Thomas Gülden
Munich, Germany

8 comments
Comment actions Permalink

Hello Thomas,

We have upgraded the engine of the built-in help. Now it has the Print button,
so you can try printing it. If any problems occur, you are welcome to file
JIRA request on documentation. Not sure about PDF version, but after the
release we are going to publish the help online, and it will also be "printable".

Documentation is constantly updated, and new features are covered. Yes, not
all the new features are documented yet. But in the beta version you can
see help for the following new functionality:

1. EJB support (including EJB 3.0)
2. IDE Talk plugin
3. VCS (the part was restructured and updated with new features like Changes
tool window)
4. Refactoring (this part was significantly changed and extended with more
examples)
5. GUI Designer
6. Code Coverage

We are also going to update and significantly change the Web&Enterprise development
part of the help and information about static code analysis and code inspections
(this work is in progress now). We haven't yet added info about the new style
of project configuration and profiles, but of course it will be available
in the release.

In fact, in each EAP version all the changes made in documentation during
the period between EAPs are available. And you are welcome to test it and
file JIRA requests.

Best regards,
Alexandra Rusina,
Technical Documentation Team Lead
-


JetBrains, Inc
http://www.intellij.com
"Develop with pleasure!"

Hi,

As IntelliJ 6.0 is in beta stage right now, I want to raise the
question again: Will - finally - a user documentation in a
printbable format (like PDF) be provided in the final release?
In a previous thread, JetBrains stated that documentation will be
strongly improved in IntelliJ 6.0. Can somebody elaborate, what is
planned?

In my opinion, documentation should also be beta tested, in order to
eliminate mistakes or to get feedback, where the documents need
improvements or what is missing.

The reason I ask for printable documents is that I do not like to read
long documents on screen and prefer to read docs when I am not in the
office or at the computer.

Kind regards

Thomas Gülden
Munich, Germany



0
Comment actions Permalink

Documentation is constantly updated, and new features are covered. Yes,
not all the new features are documented yet. But in the beta version you
can see help for the following new functionality:

1. EJB support (including EJB 3.0)
2. IDE Talk plugin
3. VCS (the part was restructured and updated with new features like
Changes tool window)
4. Refactoring (this part was significantly changed and extended with
more examples)
5. GUI Designer
6. Code Coverage

?? 7. Plug-in development?
What about Plug-in development? This topic is the worst ever covered, and there are hardly any docs
(except those few in the dev package and on your site).

Are there any plans to improve the situation for Demetra?

Thanks in advance,

Ahmed.

0
Comment actions Permalink

Hello Ahmed,

AM> ?? 7. Plug-in development?
AM> What about Plug-in development? This topic is the worst ever
AM> covered, and there are hardly any docs
AM> (except those few in the dev package and on your site).
AM> Are there any plans to improve the situation for Demetra?

It doesn't look like we'll be able to make any major improvements before
the release. There's a big new article about our DOM API, and there will
be some more JavaDoc, and that's about it.

--
Dmitry Jemerov
Software Developer
http://www.jetbrains.com/
"Develop with Pleasure!"


0
Comment actions Permalink

To get a printable help, I suppose you could use Adobe Acrobat's WebCapture feature to produce a single PDF document from the help files available online. It won't be perfect, but may be acceptable depending on what you're going to use it for.

Sascha

0
Comment actions Permalink

Honestly, I do not understand why anyone would release such a product without providing documentation that is printable. On-line help is fine if you are looking for a specific thing, but nothing beats having something printed when you want to cruise through documentation, see what's what, and so forth. Even if I had to pay $50 for WELL-WRITTEN AND USEFUL documentation (such as a real book), that would be fine. Lack of documentation is a major detriment to buying. Are people supposed to just "figure it out" ? This is why people are reluctant to use an IDE in the first place. Rather than spending forever trying to "figure it out" all on my own, I'm better off using vi, javac, and getting some paying work done.

I see this thread is a year old - as any documentation been made available? It's now August 07!!

THanks
jj

0
Comment actions Permalink

A book is available : http://www.manning.com/fields3/

And the off-line help has been revised (visual and structural) in IDEA 7

HTH,
Ruben

0
Comment actions Permalink

Alas, the book mentioned is 2 versions out-of-date (it talks about version
5, and only as sidebars, so really it's even older than version 5).

Is there a real demand for such a book? I've been thinking of writing one
(more like 100 pages rather than 500), but it doesn't seem like these books
sell very much.

;ted

"Ruben Boer" <no_reply@jetbrains.com> wrote in message
news:28834333.1193123575520.JavaMail.itn@is.intellij.net...
>A book is available : http://www.manning.com/fields3/
>

And the off-line help has been revised (visual and structural) in IDEA 7

>

HTH,
Ruben



0
Comment actions Permalink

Alas, the book mentioned is 2 versions out-of-date (it talks about version
5, and only as sidebars, so really it's even older than version 5).

Is there a real demand for such a book?

I think there is a real demand for IntelliJ books as they don't exist (or
are totally outdated).
The problem is however with the target audience:
For the normal/simple IntelliJ user, the official documentation as PDF for
print would be more than enough.

What is really missing is a book(s) about writing IntelliJ Plugins, and
I think this would sell really well.

Ahmed.

0

Please sign in to leave a comment.