Documentation Samples

Please note: Much of the work done by CyberText Consulting is confidential to our clients, so only a few examples—including those that are publicly available—are displayed here. Most examples are screenshots of single pages or topics, not complete systems. Most were done many years ago.

HTML Help

  • FracSIS 5.x Installation Guide: Audience: System administrators; created using Author-it.
  • Getting Started (tutorials): Audience: New users of Dolphin Software's email-surveys software; Author-it was used to publish both the HTML Help (CHM) file and the PDFs.
  • Email-surveys: Audience: Users of this software application; created using Author-it.
  • Analysis Designer: Audience: Designer users of occupational health and safety software; created using Author-it.
  • ProdTrak: Audience: Stockpile managers on mining sites; created using RoboHelp.
  • Ramesys: Audience: Cost modellers in large corporations; created using Author-it.
  • Asset Management System: Audience: Corporate users of an intranet application; created in "vanilla" HTML, then compiled into HTML Help.
  • Software Distribution Toolkit: Audience: System administrators.

Websites

  • Bridgetown-Greenbushes Chamber of Commerce and Industry (redesigned by CyberText in 2009; volunteer project)
  • Scotts Brook (designed by CyberText in 2007)
  • Fractal Technologies (redesigned by CyberText in 2007)
  • Minarco-MineConsult website (designed by CyberText in 2007)
  • Prestologic website (designed by CyberText in 2007)
  • CyberText Consulting website (this one!)

Word and other paper-based documents

  • All FracSIS 5.x documentation: Audience: Users of an existing software application; created using Author-it.
  • Procedural steps: Audience: Users of an existing software application, explaining how to interface that program with a new intranet application.
  • VET User Guide: Audience: Users of a new intranet application.
  • Netscape Composer (training manual): Audience: Secondary school teachers who needed to know the basics of how to create a personal web page using Netscape Composer.
  • Netscape Navigator (training manual): Audience: New internet users in a government department; it covered basic internet searching techniques.
  • Plant operating procedures: Audience: Site personnel on a nickel and cobalt leaching and refining plant; this document was one of hundreds of 'Best Operating Procedures' written; the aim of these documents was to standardize operating practices and to achieve National Competency benchmarks for site personnel.
  • SAP Quick Reference Sheet: Audience: SAP users in a mining company; this document was part of a series of Quick Reference Sheets written for the SAP upgrade.
  • Adding a local printer (quick reference card): Audience: Teachers in government schools.
  • BlueChat software (instructions): Audience: Members of the Australian Chapter of STC; Author-it was used to create this document (PDF; 50kb).
  • FracSIS User Manuals, Tutorials: All user manuals, tutorials, and installation guides for FracSIS 5.x; Audience: Geologists and geophysicists mostly; created using Author-it.
  • Other Author-it examples: Several Word/PDF articles, presentations, and handouts done about using Author-it; following the premise of 'eat your own dog food' (!), all were created using Author-it except the example "Variables" handouts.
  • New features in Office XP (information brochure): Audience: Teachers in government schools who were having their computers upgraded from Microsoft Office 2000 to Office XP; this 12 page document (created with Microsoft Publisher) summarised the new features in Office XP; only two pages are shown in this PDF.
  • All CyberText's Newsletters prior to September 2003 were created using Microsoft Publisher; between September 2003 and December 2007, the newsletters were published using Adobe InDesign. In both cases, they were saved to PDF from their respective DTP software.

HTML

(Help over an intranet for web-based applications)

  • Intranet site: Audience: Staff of a software company; created in "vanilla" HTML with some PHP includes; all layout done with CSS.
  • Epsilon (working title): Audience: Users of this web-based application; created using Author-it.
  • SDS: Audience: Users of Spatial Data Server application; created using Author-it.
  • Mesh: Audience: Geologist and Geophysicists; created using Author-it.
  • Rosendorffs (policies and procedures): Audience: Staff of this retail company; created using Author-it.
  • Bookmark Central: Audience: Users of an intranet application; created in "vanilla" HTML, not HTML Help.
  • Asset Management System: Audience: Users of an intranet application; created in "vanilla" HTML; internal links on a page were to a "drop-down" screen shot, using JavaScript (DHTML) - one such screen shot is included in this graphic. The objective was to give the textual information required, and if the user needed to see the screen being described, they could do so by clicking on the link. For those users who were familiar with the screen, we hid the screen graphics from them so that they just got the text they needed.

Captivate

  • FracSIS software movie tutorials (2005-2007)
  • Mesh software movie tutorials (2006-2007; no longer publicly available)
  • Spatial Data Server software movie tutorials (2005-2007; no longer publicly available)

Articles

ForeHelp

Note: ForeHelp 'died' in 2001

  • DeepSee Studio Pro: Audience: Graphics users converting 2D movies into 3D. The target audience used a variety of operating systems and browsers, so the Help had to work on both Windows and Macintosh, and in both Netscape and IE versions of these operating systems. Screen shots were linked as popup windows; the only graphics included in the main help file were toolbar buttons and small graphics denoting a Note, a Hint, etc. This Help system was designed using ForeHelp's InterHelp.
  • OpticBoom Photo: As above.

WinHelp

  • Network Printer Manager: Audience: Corporate users; this was a small commercial application that allowed the sharing of printers across a global network.
  • Microfusion Informatif: Audience: Library staff. Extensive use was made of popups, and hotspots in graphics. Created in Word and compiled using the WinHelp engine; the compiled HLP file consisted of hundreds of topics and context-sensitive links.