Glockenspiel IconoClass Technical Writing
C++ Class Browser Software


The IconoClass C++ browser was a joint development between Glockenspiel (Dublin) and Coopers & Lybrand (Boston). At the time, Microsoft C++ didn't exist and Borland C++ was still DOS-based, so there was a clear market for a Windows-based browser.

Being able to program in C++ gave me an uncomfortable advantage on this project: as I worked on the tutorial it became clear the program had significant gaps and was probably about 18 months behind, and not the 4 being touted!

The product never made it to the market: development ceased after Coopers & Lybrand reorganised and got out of the software business; Glockenspiel was struggling to find a buyer and didn't have the cash to pursue it.

The following is a short excerpt from the uncompleted documentation.


The IconoClass WorkSpace

IconoClass has four resizable Panes. The panes represent a hierarchical view of your software project: Applications, Components, Functions and Names. Each pane has an associated filter so you can control the level of detail shown in each.

The lower half of the window, the work area, is where you edit your code. It displays the various document windows opened by IconoClass as you work on a project.

Each pane has a particular set of document windows associated with it so the windows available at any time depend on the active Pane. For example, Make File windows are only available when working with Applications.

The Applications Pane

Iconoclass uses the concept of an "application" to group software components together. You use applications to sub-divide your software projects into more manageable units. The Applications Pane lists all the applications available in a software project and there are three: Applications, Libraries and Subsystems.

Components Pane

Applications are made up of individual Components: classes, functions (known as Modules) and resource files. The Components Pane lists the Components associated with the active (selected) Application.

Function Pane

Functions belong either to a C++ Class or a Module. The Function Pane lists the functions associated with the active (selected) component. Setting the Component Pane filter to Class shows the selected class's member as being either private, protected, public, or inherited. Setting the filter to Module shows functions as being either Global or Static.

Name Pane

The Name Pane lists the variables, data types, macros, typedefs and enums associated with the active Function.

The Documentation Window

To encourage a consistent approach to documenting code, Iconoclass provides a number of templates to be (optionally) filled in as the project progresses. Whenever you create an application or a component, IconoClass generates an associated template. You modify the template from within the Doc Window.

This template provides a number of useful headings under which you can insert the appropriate details about the application. For example, you can describe its purpose, the classes and resources it uses as well as entering maintenance information in the 'change log' section.

You can choose to accept the suggested outline of descriptive headings, or you can delete the template and insert your own text.

The Transcript Window

The Transcript Window records the progress of Iconoclass's activities. The Transcript window appears iconized outside of IconoClass, on the desktop. If Iconoclass does not appear to be working correctly, the messages in the Transcript window may help you identify the problem's origin.

Whenever Iconoclass uses the parser on your code, or invokes a third-party tool such as a compiler to build your applications, or a version control system to control source, it directs messages from these tools to the Transcript Window. These messages range from simple status reports of a tool's progress to warnings and error messages.

Article Portfolio
 HOME

Technical Writing

 Technology Ireland:
Keeping Manuscripts Alive

 Technology Ireland:
The physics behind diving

 IconoClass C++ Class Browser Tutorial

 Glockenspiel Commonview C++ Tutorial

 Symantec Q&A for DOS

Advertising / Brochures

 Corel Radio Ad

 Elverex - Brochure for QA test tool

 Glockenspiel CommonView Advert

Corporate Communications

 Stock Option FAQ - Braxtel

 Consolidation Notice - Braxtel

 Employee Letter - Braxtel

Magazine Writing

 Kitesurf UK: Irish Kitesurfing Tour

 Amstrad PC: Mail Merge Techniques

 Management: Incentive Travel

 Business & Finance: The Diving Business

Industry Speeches / Articles

 Managing Change in Corel

 Localisation: The need for Certification

 Localisation: Strategic or Simply Engineering?

 Houdini: Symantec's Localisation Help Tool

Softskills Courseware

Under Construction
© 2001 John Rowley - All rights reserved.