N-Gage SDK Documentation & Production

N-Gage SDK Documentation & Production N-Gage SDK Help: Rory Christianson

N-Gage SDK Help Installed N-Gage SDK Help: Rory Christianson

N-Gage SDK Help Compiled Help Module (CHM) Quick access, simple, centralized search N-Gage SDK Help: Rory Christianson

The “Old” way Help was produced • Word documents • Visio/Paint for diagrams • Adobe Acrobat delivery Benefits Downside • Commonly used tools, no training required • Help looks good • Printouts are high quality • Time consuming • Manual assembly required • No central search • Long turnaround on changes • Developers didn’t like it • Not web compatible • Links few and break easy N-Gage SDK Help: Rory Christianson

The “New” way of producing Help • CHM – MS Help DOS • XML – Epic Editor • UML Diagrams - Rational Rose • Header Processing - Doxygen • Perl • Python • Excel • Snagit • Illustrator • Photoshop • Carbide.c++ • Acrobat • Ultraedit • BeyondCompare • Symsee (et al) Downside Benefits • Fast turnaround; thousands of files • Scripted document assembly • Centralized search • Website compatible • C++/Header code reference included • Smaller filesizes • One person can manage • Complex script, hard to modify • Print quality substandard • XML learning curve • Not completely automated yet • Requires more programs/expertise N-Gage SDK Help: Rory Christianson

Technical Writing N-Gage SDK Help: Rory Christianson

Documentation Sources • Developer Support (Krystal, Sean, Van, Amonn) • SDK Team (Tony, Bill, Ashwini, Julius) • Software Certification via TSW Errors • Specifications (Sarb, Tony) • Doors (previously Calibre) • Technical Writer (through collaboration with subject matter experts) • API Developers (Teleca, MRT iDreams etc.) • Author Headers using Doxygen style comments • XML authored by developers using N-Gage template • API Concept Level Document (CLD) • Rational Rose for UML Diagrams • Arbortext EPIC 5.1 XML Editor • MS Word is not used N-Gage SDK Help: Rory Christianson

Delivery & Target Audience • Registered Game Developers • Internally, reference to use to facilitate testing • Developer Channels (Popstar fingerprinted SDK installers) • Forum Nokia – N-Gage Zone • Web (currently SDK 1.2, SDK 2.0 under way) • Email direct to developers (individual API’s) N-Gage SDK Help: Rory Christianson

Quality Control • First stage • API Developer first draft • SDK Team Technical Review • Structure, English and Grammar review • Second stage • Second review of structure, English • Internally posted CHM files on Public drive • XML Files formally reviewed by PrintCert team (English, Grammar, Lexicon, Legal) • Third stage • Release Candidate - TSW Errors from certification testing • Continuous • Developer feedback, TSW errors via Developer Support • Forum Nokia, observation of deficiencies N-Gage SDK Help: Rory Christianson

Building and Compiling • XML files • PNG images • Headers (*.h) • Code (*.cpp) • All in Synergy Source: Configuration: Script Engines • Excel Class/Capabilities • Excel API Sheets • XML API Structure • XSL Convert templates • Doxygen Config • HHP Compile • HHC Table of contents • Word Index • Perl • Doxygen • MS Help • Batch Script • Python N-Gage SDK Help: Rory Christianson

Scripts – Perl + Batch N-Gage SDK Help: Rory Christianson

Scripts – XML Contents Configuration N-Gage SDK Help: Rory Christianson

Doxygen – Finished Results N-Gage SDK Help: Rory Christianson

Doxygen Process N-Gage SDK Help: Rory Christianson

Doxygen – Embedded Comment Format N-Gage SDK Help: Rory Christianson

Doxygen - Tags N-Gage SDK Help: Rory Christianson

N-Gage API Reference Structure N-Gage SDK Help: Rory Christianson

Statistics - Overview • 16 Help files delivered with the SDK “NGageDoc” folder • 11 interlinked help modules • 2 PDF files (installation guide) • 1 Release Notes text file • 2 JAR Java help Symbian + S60 API Reference (Carbide.c++) • 162 MB size of all help files • 26,229 files inside the compiled help • 261,942 hyperlinks (excluding Symbian) • 48 API’s (10-50+ pages each) • 3 are large, stand-alone CHM’s: OpenC, LibXML, C++ STL • 34 API Examples with header & code reference • 655 total header files processed through Doxygen N-Gage SDK Help: Rory Christianson

Statistics – Help Files in the N-Gage SDK N-Gage SDK Help: Rory Christianson

Testing • Technical Review • API CLD (Concept Level Document) • English • Document template structure • SGR-L compliance • Header (Doxygen, correct tag usage) • English and Grammar Check • First read before Technical review • Pre-flight check • Print certification fine-tooth check • TSW Errors • Software certification team • From Developer Support • Weekly internal builds • Document structure check • Match to requirements (Doors) • Rational Rose UML diagrams • Other images and screenshots • Examples compile ok • Screenshots match examples • Links • Web links • Bookmarks • Cross CHM links N-Gage SDK Help: Rory Christianson

Reports & Metrics N-Gage SDK Help: Rory Christianson

Tools –” FAR”, for Testing & Manual HTML Assembly N-Gage SDK Help: Rory Christianson

Tools – Arbortext Epic (XML Editor) N-Gage SDK Help: Rory Christianson

Tools – Rational Rose for UML Diagrams N-Gage SDK Help: Rory Christianson

N-Gage / NGI Wiki page http://nwiki.nokia.com/NGISDK/WebHome N-Gage SDK Help: Rory Christianson

Glossary of Terms (Wiki) N-Gage SDK Help: Rory Christianson

Standards • XML templates for API CLD • XML templates for Examples • Doxygen legal @tag usage • N-Gage Document Style Guides • Test set for PrintCert team • S60 original parent for XML standards • Created the documentation scripts • Originated the XML concept • Epic XML Editing • Link structure • Image format, size, characteristics N-Gage SDK Help: Rory Christianson

Tools – Snagit for screen capture N-Gage SDK Help: Rory Christianson

Future Communicators! N-Gage SDK Help: Rory Christianson

N-Gage SDK Documentation & Production