Brent suggested that we carry out this
discussion on vtp-dev. So here are some thoughts on Voice Tools documentation.
I will be happy to see Brent’s
reorganization of the top level. That should be better for contributing new
stuff into.
-- Mike
From: Brent D Metz
[mailto:bdmetz@xxxxxxxxxx]
Sent: Thursday, January 12, 2006
7:24 AM
To: Michael Greenawalt
Cc: Randy Ray
Subject: Re: Documentation
Thanks for putting this together. My thinking is to
reorganize at the highest level into Getting Started, Concepts, Tasks, and
References. This seems to be the top level design of existing help inside the
Eclipse help contents.
I
like your approach. The biggest thing to cover is the simplest stuff - how to
get skype, how to get a tellme studio account, and so on.
--
Brent D. Metz
Enterprise
Voice Tools
bdmetz@xxxxxxxxxx
"Simple things should be simple, and complex things should be
possible." - Alan Kay
|
"Michael Greenawalt"
<mgreenawalt@xxxxxxxxxx>
01/11/2006 08:37 PM
|
|
To
|
Brent D Metz/Boca Raton/IBM@IBMUS
|
|
cc
|
"Randy Ray"
<rjray@xxxxxxxxxx>
|
|
Subject
|
Documentation
|
|
Brent –
I am
thinking about the documentation for VoiceXML Browsers that should be created
for Eclipse Help. Let’s discuss structure of the docs:
Right
now there is:
Voice
Tools
CCXML information
SRGS-XML information
VoiceXML information
Voice Tools DTD Catalog
I
propose we have the following: (new stuff in red)
Voice
Tools
CCXML information
(org.eclipse.vtp.editor.ccxml.doc)
SRGS-XML information
(org.eclipse.vtp.editor.srgxml.doc)
VoiceXML information
(org.eclipse.vtp.editor.vxml.doc)
Voice Tools DTD Catalog
(org.eclipse.vtp.doc)
VoiceXML
Browsers
(org.eclipse.vtp.launching.doc)
Concepts
Application
URL/Serving the app
VoiceXML Browser
Input view
Tellme VoiceXML Browser
(org.eclipse.vtp.launching.tellme.doc)
Concepts
Tellme Studio
(introduction to Studio facilities)
(description of notions of scratchpad and debug log)
(Studio
as a source of information)
VoIP Dialer
(Discussion of use of VoIP phone API to manage Studio)
(Discussion of notion of multiple dialers possible)
Tasks
Getting Started (Skype install)
(Where to
get Skype)
(installing Skype)
(registering with Skype)
Registering with Studio
(getting
id and password from Studio)
Oopses
(dealing
with the “fast busy”)
(limitations of log streaming)
(hopefully this section is not needed long term)
BrandX VoiceXML Browser
Concepts
Tasks
…
If we
go this way, two layers need to be defined: The VoiceXML Browser layer
that is generic, and then the Tellme VoiceXML Browser layer. Certainly Tellme
gets to do the second. Who wants to do the first? I can get it started in a
pinch.
What
do you think?
--
Mike
