M block2 istc_talk_sept2010

Slide 1: A new product to document...

Slide 2: Lots of right-clicking the tree…

Slide 3: Why not capture ‘right-click/select/do/result’ in one picture?

Slide 4: Exploded view...

Slide 5: Using text boxes/arrows to annotate a completed dialog box…

Slide 6: Using a cascade of images to illustrate a progression...

Slide 7: Shows the user (a) the tool, (b) what to right-click, (c) what menu item to select, and (d) how to complete the resulting dialog box.

Slide 8: Step-by-step illustration of how to complete a dialog box…

Slide 9: Picture representation of paths to files…

Slide 10: What happens on completing a task...

Slide 11: What is the effect of changing different settings.....

ProtocolConverter

Devices sending and receiving messages over

Protocol B

Are you OK?(Protocol A)

Are you OK?(Protocol B)

Yes I’m fine(Protocol B)

Yes I’m fine(Protocol A)

Devices sending and receiving messages over

Protocol A

Slide 12: Illustrating a concept…

Slide 13: Explaining a concept…

Slide 14: Documenting a large dialog box broken into discrete compartments...

Client machines

Witness server

Primaryserver

Standbyserver

PRIMARY SERVERRole:

· StarWatch server. The first-choice SQL database server for StarWatch. Also mirrors any changes to the standby server as they happen.

Operating system:· Windows Server 2003/2008.

Version of SQL Server 2008:· Standard/Enterprise (+ SP1 or

above).Version of SQL Server 2005:

· Standard/Enterprise (+ SP3 or above).

CLIENT MACHINERole:

· For operator usage of StarWatch. It looks to the StarWatch database on the primary server until such time as a database failover occurs, at which point it turns to the StarWatch database on the standby server.

Operating system:· Windows XP (+SP3 or above) or

higher, such as Windows Vista or Windows 7.

· Windows Server 2003/2008.Version of SQL Server 2008/2005:

· Not applicable.

WITNESS SERVERRole:· Server monitoring the health of the primary and

standby servers. Initiates a database failover between the primary and standby servers if required. Note that the witness server does not have StarWatch installed.

Operating system:· Windows XP (+SP3 or above) or higher, such as

Windows Vista or Windows 7.· Windows Server 2003/2008.

Version of SQL Server 2008:· Express (+SP1 or above)· Standard/Enterprise (+ SP1 or above), for which

Windows Server 2003/2008 is requiredVersion of SQL Server 2005:· Express (+SP3 or above).· Standard/Enterprise (+ SP3 or above), for which

Windows Server 2003/2008 is required.

STANDBY SERVERRole:

· StarWatch server hosting the copy of the StarWatch database mirrored from the primary server. In failover situations, it takes over from the primary server as the first-choice SQL database server for StarWatch.

Operating system:· Same as for primary server.

Version of SQL Server 2008/2005:· Same as for primary server.

Slide 15: Single picture showing system architecture and software requirements...

Slide 16: Illustration of what a set of display options means in practice...

Slide 17: Page-by-page descriptions of wizard pages...

Slide 18: For some wizard screens, text boxes will not suffice and a fully documented procedure is required...

Slide 19: Overview of a procedure, with constituent steps matching the table of contents...

Stage 1: Prepare new SCD configuration file

Stage 5: Add feeders to SCL tree

Stage 6: Addswitchgear to SCL tree

Stage 7: Add logical nodes individually to

SCL tree

Stage 11: Set up data reporting

Stage 10: Specify server capability

Stage 12: Set up communications

sub-networks

Stage 13: Save and close SCD file

Initial preparations solely for synchro-checking

Runwizard

Create new logical node types (specifically for

GGIO and ELOG)

Add logical nodes

Add external inputs

Set up datasets

Set up report control blocks

Create ‘client’ GGIO logical node types

Add clients

Add client logical

devices

Add logical nodes

Createbearers

Associate bearers

with clients

Create bearers Add Servers

Create communications

sub-network

Add Callistonx units to sub-networks

Open a new file

Add substation

Add physical devices

(Callistonx units)

Save file as SCD file

Runwizard

Remove unwanted

items added by wizard

Rename logical nodes

Remove unwanted

items added by wizard

Rename logical nodes

Stage 2: Draw SLD (single line diagram)

Add voltage levels, bays and equipment items

Manipulate equipment

items

Add connectivity

Stage 3: Add logical nodes to SLD

Decide which logical nodes

to add

Mark up printout of

SLD

Add logical nodes to

equipment items

Add logical nodes to bays and

voltage levels

Stage 4: Add logical devices to SCL tree

Stage 8: Associate logical nodes in SLD

and SCL tree

Stage 9: Specify client capability

Slide 20: The complete picture...

Slide 21: Map of web pages…

Slide 22: Circular progression through (in this case) a set of screens…

Slide 23: If picture width is an issue for you (that is, you may occasionally need to crop pictures to make them narrower), then consider what ‘Message Box’ style is in force on your PC.Here, ‘Windows XP style’ (left) is more suitable than ‘Windows Classic Style’ (right) because it has a constant pattern across its width, allowing for seamless cropping:

Slide 24: Make sure that any field entries in pictures are sensible and help to clarify what is going on…

Slide 25: Names of tree entries chosen to strengthen the text...

Slide 26: Be sure to remove or edit any mention to real people, places , IP addresses and so on….

Advantages:• Conveys lots of information quickly and

clearly• Visually appealing• Better for the user

Disadvantages: • Time-consuming

• Labour-intensive• Can be excessive and even unhelpful

(overkill?)• Increases document length and weight• Ages documents more quickly