Portfolio

Technical documentation

OmiseGO

OmiseGO’s publicly available documentation was published on GitHub. Content created and edited for OmiseGO consists of markdown files created either directly in GitHub, or using Docusaurus.

• OmiseGO - Using a browser for DAI transactions on the OmiseGO Network
• OmiseGO Network upgrade guide

CSG International

Documentation

For the first 2 - 3 years at CSG, I created and managed documentation for a locally developed telecoms product. When this product was replaced by a product developed by a remote team, I transitioned to the new team to establish a documentation process. This involved analysing the existing documentation set, identifying subject matter experts, reducing content to lower the documentation overhead, and editing legacy content. Project managers and the team were kept informed regarding document status by way of regular documentation status reports.

CSG content was created and published using oXygen XML Editor with DocBook XML. Documents were published as Word files, PDF, and Webhelp, checked in with the code to a version control system, and shipped with the product. The CSG documentation is only available to customers. Anonymized content snippets will be provided.

• User guide
• Administration guide
• Installation guide
• API guides

Desktop support and system administration

While performing my role as a technical writer at CSG, I supported a remote technical team responsible for upgrades of the site’s on-premise Confluence and Jira instances. As the frontend administrator, I communicated with users around system upgrades, tested new functionality, investigated and proposed new plugin requests, and provided day-to-day desktop and project support to co-located and remote users. Additionally, I managed a legacy SharePoint site, coordinated the gathering and delivery of handover materials to global product enablement, and represented the site for global quality standards.

KnowledgeTree

Note: KnowledgeTree no longer exists as an independent entity. As an open source-commercial system, all documentation was publicly available online.

KnowledgeTree documentation was created and published using Help & Manual. Documents were published online as Webhelp and PDF files.

• JMS, online help - documenting a complete jewelry management business process software system for a large South African retailer
• KnowledgeTreeLive Quick Start Guide
• KnowledgeTree Installation and Upgrade Guide
• KnowledgeTree Client Tools User Guide
• KnowledgeTree User Manual
• KnowledgeTree Administrator Manual
• KnowledgeTree installation guide

London Bridge Group

London Bridge Group was acquired by Fair Isaac, which later sold on the Phoenix Banking System.

Documentation was created and published using Robohelp. Content was published as context sensitive help within the system, and available only to customers.

• Phoenix Banking System, online help

Editing, proofreading, content creation

• Proofread and edit, doctoral thesis: This work involved substantial editing and restructuring of a first complete draft of a PhD thesis, prior to submission for the final (credited) academic edit.

• Course creation and development, Laragh Courseware Effective Presentations with PowerPoint

• Proofread and edit, research article, health and nutrition study in Brazil

• Article, Silicon Cape Initiative