#27 CQPweb: Provide user documentation

TODO-3.5
closed
Andrew Hardie
CQPweb (34)
5
2014-06-16
2009-10-27
Duminski
No

I havent installed CQPweb yet, but - having looked only at the "very quick notes how to setup CQPweb" - suspect more than 15min will be needed for the first time installation user (digging out the Ubuntu package dependies took almost 10 min here, stopped after that). It would be therefore great to have documentation (if possible screenshots) available to justify the installation cost (as long as no prepacked debs or rpms are available) and know beforehand what the software can do and if it might fit to help in solving the users problem.

Discussion

  • Andrew Hardie
    Andrew Hardie
    2009-10-28

    • summary: Provide user documentation --> CQPweb: Provide user documentation
     
  • Andrew Hardie
    Andrew Hardie
    2009-10-28

    I'd say that installation will DEFINITELY take more than 15 minutes - not unexpectedly, it's a pretty complex system if you include the other stuff it depends on (when you refer to Ubuntu package dependencies I assume you're talking about those for MySQL, CWB, etc.) "Very quick" refers to the notes, not to the process of installation!

    Anyway: screenshots is easy enough, and I will post some I've collected on an external website. Documentation is another matter - there is an awful lot to document and it tends to be done on an as-needed basis in the form of handouts for workshops, seminars etc.

    If you're trying to decide whether to invest in the effort to install CQPweb, the best way is to try it out. CQPweb replicates BNCweb, which you can sign up to use here:
    http://bncweb.lancs.ac.uk/bncwebSignup
    If you like BNCweb, you'll like CQPweb as it has the same functionality (give-or-take), but for any corpus.

    Similarly, for documentation I often refer people to the "BNCweb book", that is, Hoffmann et al 2008 ( http://corpora.lancs.ac.uk/BNCweb/home.html#book ) which is more detailed than anything I can manage in the immediate future for CQPweb. One piece of documentation I *am* committed to producing, when I get time, is a guide to that book highlighting the points where CQPweb and BNCweb differ.

    cheers

    Andrew.

     
  •  Duminski
    Duminski
    2009-10-28

    Thats great, Thank you very much!

     
  • Andrew Hardie
    Andrew Hardie
    2014-06-16

    Between youtube videos and the written sysadmin manual, there is now lots more documentation, (though mroe is always needed) so I'm closing this ticket.

     
  • Andrew Hardie
    Andrew Hardie
    2014-06-16

    • status: open --> closed
    • Group: --> TODO-3.5