[OLD] Documentation

[Jamie Edwards]

Hi everyone;

My name is Jamie Edwards and I have recently joined Kayako to lead the documentation of all Kayako's products.

I will be posting updates on completed documentation as and when they are completed in this thread. Progress on the documents is already well under way.

All manuals and guides will be available in PDF and CHM. Following completion of the first phase of documentation, we will be porting the documents into a Wiki as an additional format that will make access to the guides easier from the internet.

If you have any questions or suggestions please post them there.

Formats

• To be available in PDF, CHM and following publication of these two formats, a community editable Wiki version of the documentation will be maintained.
  

Released Manuals & Previews:

• InstaAlert Manual (Complete)
  CHM: Click here
  PDF: Click here
  
  
• Staff Control Panel (Complete: Proof-reading stage)
  CHM: Click here
  PDF: Click here

[wpcomp]

Will these new updates include template editing guides and a database/variable map?

The mail parsing instructions could use some work too...especially when and how to setup multiple departments using one email address and how to use the group/manager feature.

-Vic

Originally Posted by Jamie Edwards

Hi everyone;

My name is Jamie Edwards and I have recently joined Kayako to lead the documentation of all Kayako's products.

I will be posting updates on completed documentation as and when they are completed in this thread. Progress on the documents is already well under way.

All manuals and guides will be available in PDF and CHM. Following completion of the first phase of documentation, we will be porting the documents into a Wiki as an additional format that will make access to the guides easier from the internet.

If you have any questions or suggestions please post them there.

[Jamie Edwards]

Hi Vic;

All features in the use of the software will be documented thoroughly - using groups, managing users, using the parser and so on.

A guide to the database/variable mappings (more of a developers API, than a manual) will not be covered but may be something to be considered later on.

Right now, we are developing documentation and guides to using the software (eSupport client, staff, admin and PDA interfaces, InstaAlert, LiveResponse, SyncWorks and Kayako Mobile).

The current installation documentation is also due to be updated within this documentation.

Thanks;

Jamie

[Jamie Edwards]

Greetings everyone,

We are pleased to bring to you the first in the series of documentation for our line of products.


Kayako InstaAlert User Manual: CHM Format
http://docs.kayako.net/instaalert/Kayako_InstaAlert_Manual_CHM_1.0.1.chm


This document should serve as a preview for the user manuals that are being developed for all Kayako products. There are currently a few minor formatting issues - such as excessive use of white space. The document has been designed this way while we work on cross-compilation into both PDF and CHM as described in the first post.

We are very serious about providing thorough, easily accessible documentation for all of our products and we look forward to hearing your thoughts, suggestions and ideas while we continue development of other documentation.

[eiden]

Looks very good!

When do you expect to have the staff and admin manuals ready ?

[itechwest]

Looks great, but I think you can clean out some of the waisted space, especially in the trouble shooting area.

[Jamie Edwards]

Originally Posted by eiden

Looks very good!

When do you expect to have the staff and admin manuals ready ?

There is no definite deadline set for the release - we don't want to raise hopes and we don't want to ruin any! I can tell you the documents not an age away, however.

Originally Posted by itechwest

Looks great, but I think you can clean out some of the waisted space, especially in the trouble shooting area.

Thank you for the suggestion - as posted in a post earlier the whitespace will be removed, but for now it exists while I decide on how we will be compiling to both PDF and CHM.

[bear]

Welcome Jamie, great to see progress in a much needed area. Can't wait to see the CHM versions.

[Kevin Allen]

Great to see you on board, Jamie.

I'll add myself to the list of people anxiously awaiting STAFF and ADMIN manuals.

- Kevin Allen

[Jamie Edwards]

Staff CP Preview 1: Staff Control Panel Manual

Greetings everyone;

We are pleased to be able to present the first in a line of preview releases showing the development of the staff control panel manual.

Download CHM:
http://docs.kayako.net/staffcp/Kayak..._CHM_1.0.8.chm

Download PDF:
http://docs.kayako.net/staffcp/Kayak..._SRC_1.0.8.pdf

As usual, please be aware that this is a development preview and any missing information, minor contextual mistakes and missing cross references will be corrected during the course of development.

I hope this preview serves as a good taster for the level of detail you can expect from our documentation.

Any suggestions and comments are welcome

[wpcomp]

I'm getting an error that the archive is corrupt or invalid.

[Jamie Edwards]

Wpcomp;

Sorry you are having problems - I will look at this now.

Edit: Wpcomp: The archive opens fine here. What are you using the unzip the archive?

[sureshkumar.mr]

Even I am facing the same problem. I am not able to open it.

I am attaching screen shot for your reference.

[jpuff]

I'm facing the same.

~Unexpected end of archive
~The archive is corrupt

I'm using WinRAR.

[Jamie Edwards]

Ok, thanks everyone. I have repacked and uploaded:

http://docs.kayako.net/Kayako_SupportSuite_Staff_Control_Panel_Manual_CHM _1.0.8.chm