uima-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Thomas Hampp (JIRA)" <...@uima.apache.org>
Subject [jira] Created: (UIMA-1783) Documentation should be improved
Date Mon, 17 May 2010 08:47:48 GMT
Documentation should be improved
--------------------------------

                 Key: UIMA-1783
                 URL: https://issues.apache.org/jira/browse/UIMA-1783
             Project: UIMA
          Issue Type: Improvement
          Components: CasEditor
    Affects Versions: 2.3
            Reporter: Thomas Hampp
         Attachments: CasEditorGettingStarted.pdf

The current CasEditor documentation is far to short to allow people a smooth start. We have
been using the CasEditor a lot over the last year but were forced to write -and maintain-
a "Getting Started" guide ourselves to work around this. 

Even after more than a year of working with it I still have not figured out how to get "Processors"
to work.

Unfortunately the editor is not self-explanatory and the lack of documentation is slowing
adoption. One key point we noted for new users is the lack of mouse/context-menu equivalents
for the most important functions (add/delete/edit annotations). Of course nobody will use
them in the long run but that is where people look for the function. And that is also where
the keyboard shortcut could be advertised.

I think a sample project is crucial for better adoption (there is already a JIRA issue for
that).

I am attaching a PDF with the startup guide for our users. That is by no means perfect and
some of it's content is covered by existing documentation. But it still may be helpful.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message