Conceptual Specification

Online Help & User Manuals Feature Design Document 1 Last saved: 08 01 2000 DeltaBlues 2B Feature Specification 2 September, 2009 WebSitePros Confidential – Need to Know 2 DeltaBlues 2B Feature Specification Table of Contents 1. 1.1. 1.2. 1.3. 2. 3. 3.1. 3.2. 3.3. 4. 4.1. 4.2. 4.3. 4.4. 4.5. 5. 6. 7. 8. 9. Administration.......................................................................................................................................... 4 Document History .................................................................................................................................. 4 Current Status: Preliminary .................................................................................................................... 4 Team Members ...................................................................................................................................... 4 Introduction.............................................................................................................................................. 5 User Interfaces ......................................................................................................................................... 6 NDC ....................................................................................................................................................... 6 Site Manager .......................................................................................................................................... 6 Website Visitor ...................................................................................................................................... 7 Implementation Strategy .......................................................................................................................... 8 General Description ............................................................................................................................... 8 Key Components .................................................................................................................................... 8 Database Internals Impact .................................................................................................................... 10 Branding ............................................................................................................................................... 10 Concerns .............................................................................................................................................. 10 Testing Strategy ..................................................................................................................................... 11 Documentation Recommendations ......................................................................................................... 12 Dependencies On Other Features .......................................................................................................... 13 Future Directions ................................................................................................................................... 14 Open Issues ............................................................................................................................................ 15 2 September, 2009 WebSitePros Confidential – Need to Know 3 DeltaBlues 2B Feature Specification 1. Administration 1.1. Document History Date 25 July 2000 31 July 2000 3 August 2000 Author Sara Tolchin Michael Reznik Sara Tolchin Rev. # 1 1.1 2 Changes Initial Draft Added testing information Final Draft for signoff (changes marked in blue and with sidebars) 1.2. Current Status: Preliminary . 1.3. Team Members Department Biz Dev Design and Production Documentation Marketing NDC Product Design Programming Project Leader Testing Osmar Blanco Sara Tolchin Shirley Ladler Sara Tolchin Prasanthi Morusupalli Shirley Ladler Sara Tolchin Name Sign off / Date 2 September, 2009 WebSitePros Confidential – Need to Know 4 DeltaBlues 2B Feature Specification 2. Introduction Components to be Documented  Account Manager  Site Manager Documentation Set  Account Manager Online Help (WebHelp User’s Guide)  Account Manager printable manual (PDF version of Online Help)  Site Manager Online Help (WebHelp User’s Guide)  Site Manager printable manual (PDF version of Online Help) Proposed Format The proposed format of the documentation is WebHelp systems for the online Help and PDF versions of Word documents for the printable manuals. Users The Account Manager Help is for NDC designers. The Site Manager Help is for web site owners. 2 September, 2009 WebSitePros Confidential – Need to Know 5 DeltaBlues 2B Feature Specification 3. User Interfaces 3.1. NDC The NDC designer accesses online Help by clicking a Help button on any screen of the Account Manager. A Help topic appears with information about the screen. From there, the designer also has access to the Table of Contents, Index, full-text Search, and Browse Sequence features, as shown in the following mockup for the Upgrading a Web Site help topic. The designer can also print a PDF version of the online Help by clicking a Printed Manual (text TBD) button on any page of the Account Manager. 3.2. Site Manager The Site Manager user (web site owner) accesses online Help by clicking a Help button on any screen of the Site Manager. A Help topic appears with information about the screen. From there, the web site owner also has access to the Table of Contents, Index, full-text Search, and Browse Sequence features, as shown in the following mockup for the Using the Site Manager help topic. NOTE: Control Panel in the following screen mockup should read Site Manager. 2 September, 2009 WebSitePros Confidential – Need to Know 6 DeltaBlues 2B Feature Specification The Site Manager user can also print a PDF version of the online Help by clicking a Printed Manual (text TBD) button on any page of the Site Manager. 3.3. Website Visitor The website visitor does not have access to the Account Manager or Site Manager documentation. 2 September, 2009 WebSitePros Confidential – Need to Know 7 DeltaBlues 2B Feature Specification 4. Implementation Strategy 4.1. General Description WebHelp files: The writer creates an HTML Help system, then generates WebHelp files from the HTML Help and posts the files to the location specified by the web programmer. The writer tells the programmer the name of the page to use for the first page (the one that displays when the user opens the Help system if they’re not opening it from a Help button). The writer also provides a mapping of Help topics to screens in the site. The web programmer adds some code to each web page that has context sensitive help, to tell the page which Help topic to access. PDF files: The writer generates Word documents from the WebHelp system. With careful planning, these Word documents can have exactly the same style and format as the online Help, and yet look like a proper printed manual and not just a printout of a Help system. The writer then generates PDF versions of the Word documents, which the web programmer hooks up to the Printed Manual button on the web pages. This ensures that, at any time, users can print a manual that is laid out like a proper printed guide and has the same content as the WebHelp system. Process for creating/publishing the online and printable documentation:  Set up the HTML Help project.  Cut/paste existing text into topics.  Create new topics and writing text.  Import existing graphics.  Create new graphics.  Create WebHelp project from HTML Help project (an automated process in RoboHTML).  Create Word documents from the HTML Help project (an automated process in RoboHTML).  Create PDF file from the Word documents.  Send folder of WebHelp files to web programmer with name of start topic.  Send mapping file of Help topics to web pages.  Send PDF files for linking to Printed Manual buttons. 4.2. Key Components The following tables list the Account Manager and Site Manager 2B features that need documentation. The tables show whether the documentation exists for the feature and, if so, outlines changes that need to occur to the existing documentation. Time estimates include time for research, screenshots, creation of Help system, and inclusion of review comments. 2 September, 2009 WebSitePros Confidential – Need to Know 8 DeltaBlues 2B Feature Specification Account Manager Feature/Task Create HTML Help system List accounts Search accounts Find/change/relocate/republish Registration Upgrade Provisioning Order account on staging server Order sub-domain account Secure Pages Site locking Add form Corner Office (if integrated in Provisioning) Maps/Directions page (including documentation inside HTML template) Add/delete SmartAge functionality Preferred Partner Discounts Search Engine Services Banner Ad Services Email List Manager - Link Exchange Server Exists? No No No No No 10% Yes No No No No No No No No Changes Required Migrate existing Word docs to HTML Help (RoboHTML) Write Write Write Write Finish Make generic, rewrite, add screenshots Write up from NDC process docs Write Write Write Write Write Write Write Create WebHelp files Create PDF document No No Automatic generation from HTML Help system Create Word doc from HTML Help source; create PDF Site Manager Feature/Task Create HTML Help system Edit Website Exists? No Yes Changes Required Migrate existing Word doc to HTML Help (RoboHTML) Add any new functionality; incorporate eWebEditPro documentation Add new Dino/Wilma/Fred/ Mr. Slate functionality Add any new functionality Add any new functionality Add any new functionality Add any new functionality Add any new functionality Mercantec changes Write up Write up 9 Bedrock functionality Email admin Help desk Edit password Search engines Site statistics E-Store admin What’s New Corner Office (SmartAge_ 2 September, 2009 Partial Yes Yes Yes Yes Yes Partially No No WebSitePros Confidential – Need to Know DeltaBlues 2B Feature Specification Marketing Services Preferred Partner Discounts Search Engine Services Banner Ad Services Email List Manager - Link Exchange Server No Write up Maps/Directions page – viewing Create WebHelp files Create PDF document 4.3. Database Internals Impact None. 4.4.   No No No Write up Automatic generation from HTML Help system Create Word doc from HTML Help source; create PDF Branding Screenshots that show logos or are partner-specific will need to be recaptured for each partner. Examples will need to be rewritten using partner-specific options. Concerns Number of partners/vendors requiring branded Help is unclear. 4.5.  2 September, 2009 WebSitePros Confidential – Need to Know 10 DeltaBlues 2B Feature Specification 5. Testing Strategy            Test that Help is visible on the following browsers: IE 4.0+, Netscape 4.0+, AOL, (MAC?) Verify that all Help buttons bring up a Help topic. Test that PDF version of manual opens and prints from Printed Manual button. Spot-test links within Help (writer also responsible for testing these). Verify that all Help Buttons should be identical and located at the same place on the page. Verify that clicking on any Link should display the according help topic. Make sure that clicking on any Tab (Contents, Index, Search, Glossary) in the Help Window should open up the relative information. Verify that clicking on any items on the Menu bar (Hide, Back Forward, Print) should function Properly. Verify that clicking on Minimize, Restore and Close buttons should work properly. Verify that all static Text should be with correct spelling. Verify that clicking on up and down arrows of the scroll bar should move the content area up and down. (See detail Test plan on: P:\Product Development\QA\2B Test Plan) 2 September, 2009 WebSitePros Confidential – Need to Know 11 DeltaBlues 2B Feature Specification 6. Documentation Recommendations Advantages of WebHelp over HTML Help:  WebHelp is browser independent. HTML Help can only run if Internet Explorer is installed on the user’s machine.  WebHelp is platform independent, and can run on Microsoft Windows (95, 98, and 2000), Microsoft NT (4 and 5), Macintosh, UNIX, and Linux. Help system detects user’s platform and displays appropriate files at launch time. Advantages of WebHelp over the current HTML pages (in SA 5.0):  User gets immediate access to Help on entire application, fully integrated and easily navigable (TOC, index, full-text search), instead of only Help on the screen they are at.  Writer provides ready-to-publish Help files. This cuts out the costly step of the HTML coder manually coding pages from a Word source file.  Updates are quicker, easier, and cheaper.  Information can be divided between conceptual and procedural. User can choose whether to learn about the application or quickly do a task.  Full-text search allows user to find all information about a subject in the Help system at the push of a button.  User can see structure of application reflected in Help table of contents and get a better understanding of the flow of the application. 2 September, 2009 WebSitePros Confidential – Need to Know 12 DeltaBlues 2B Feature Specification 7. Dependencies On Other Features   Dependency on web page Help buttons being coded with context-sensitive link to correct topic. Dependency on Printed Manual buttons being linked to PDF version of online Help. 2 September, 2009 WebSitePros Confidential – Need to Know 13 DeltaBlues 2B Feature Specification 8. Future Directions 2 September, 2009 WebSitePros Confidential – Need to Know 14 DeltaBlues 2B Feature Specification 9. Open Issues 2 September, 2009 WebSitePros Confidential – Need to Know 15