1 ● Varvara Mityashina – Technical Writer, SPB TechPubs PHP SUPPORT DOCUMENTATION PLAN 1

Sun Confidential: Internal Only 2 Agenda Seven PHP IDEs compared What kinds of docs are provided by competitors What information support the Ruby team provides Our documentation plan Help needed

Sun Confidential: Internal Only 3 Seven PHP IDEs compared IBM lists the “seven great PHP IDEs”: Eclipse Komodo PHP Designer PhpED PHPEdit Zend Studio Reference:

Sun Confidential: Internal Only 4 Eclipse PDT Strong points: XDebug guide Weak points: Poor documentation coverage Poor search facilities The page structure is not informative Reference:

Sun Confidential: Internal Only 5 Komodo Strong points: Well structured information > What is new? > Starting Komodo > Editor features Tutorials cover debugging Correspondence with the IDE Sample Project Reference:

Sun Confidential: Internal Only 6 PHP Designer Strong points: A set of screen-shots Weak points: A bare list of features without any description Reference:

Sun Confidential: Internal Only 7 PhpED Strong points: A great features tour Advantages compared to other IDEs Reference:

Sun Confidential: Internal Only 8 PHPEdit Strong points: A set of screen-shots Weak points: The structure of pages is not informative A bare list of features without any description Reference:

Sun Confidential: Internal Only 9 The Zend Studio Strong points: Demo videos The information on the Resources page is well structured so each user category is addressed clearly > Quick start > Full guide > Reviewer's guide Weak points: It is not easy to “guess” how to get to the Resources page Reference:

Sun Confidential: Internal Only 10 Ruby on Rails Strong points: Demo videos The information is well structured so each user category is addressed clearly > Get Excited > Get Started > Get Better > Get Involved Attractive slogans Reference:

Sun Confidential: Internal Only 11 Best competitors' practices Well structured information clearly addressing particular types of audience Attractive slogans As much visualization as possible Features tour Sample projects and related tutorials

Sun Confidential: Internal Only 12 NetBeans IDE Ruby documentation As much visualization as possible: Demos Videos Well structured information addressing each audience type clearly Quick starts Guides Tutorials Reference:

Sun Confidential: Internal Only 13 Concept Structuring the information so each user can easily find the most suitable document. Using attractive slogans. Providing videos instead of text whenever possible. Providing a features tour. Whenever possible basing tutorials on sample applications.

Sun Confidential: Internal Only 14 Our documentation plan Guides Setting up a project Tutorials A tutorial based on a Wish-list application, which covers: > Setting up a project > Coding, debugging, and testing > Using a database A tutorial showing integration with JMaki Videos Features tour Production will be requested from the Media Design team Your Ideas? Reference:

Sun Confidential: Internal Only 15 Help needed Some examples of debugging using XDebug Sample applications for tutorials Online help module and javahelp files