Rian Murphy - Technical Writing Samples by Industry
Scroll down or follow one of these links for samples for the following Industries:
Communications
Broadcast List Manager Guide
(User Guide)
User Guide for admins using GUI to configure messaging user accounts for Internet-based messaging sofware package
IP Launchpad SOFTWARE REQUIREMENTS SPECIFICATION
Section of Software Requirements Specification (SRS) maintained for developers and product managers during design phase for new release of Internet-based messaging software server package
Installation Guide: ALERI STREAMING PLATFORM
Instructions for admins installing Complex Event Processing server software
Internet Gateway SDK User's Guide
Section of complete documentation of Software Development Kit for server software that facilitated IP messaging, using C++-based API
Release Notes: Aleri Streaming Platform
Sample Release Notes detailing latest release of CEP server software for admins and developers in the communications field
Application Note: Web-Based Message Tracker for IPLP
An end-users' guide for administrators tracking messages on the IPLP messaging server
Application Note: IPLP Hive Settings for Two NICs
Tech Note explaining hardware configuration for admins using software package as infrastructure for Internet-based messaging
E-Commerce
Business Process Flow: Procure-To-Pay
Detailed subset of flowchart set documenting d-commerce produce-to-pay processes -- swimlane flowcharts using Business Process Modeling Notation (BPMN)
Finance Data Warehouse Data Definitions
Outward-facing documentation (for management and analysts) of financial terms used as part of Data Dictionary for e-commerce Data Warehouse
Sale Process Training
PowerPoint presentation used by trainers instructing new producers of online sales e-commerce site
Finance
LMA Pricing Portal Quick Reference Guide
Graphic one-sheet documentation for end-users processsing load information for financial firm
Booking a New Loan Overview
Step-by-step guide for processors entering loan information into financial company's mainframe, developed using Info Mapping technique
Finance Data Warehouse Data Definitions
Outward-facing documentation (for management and analysts) of financial terms used as part of Data Dictionary for e-commerce Data Warehouse
Infrastructure
IPLP Application Note: IPLP Hive Settings for Two NICs
Tech Note explaining hardware configuration for admins using software package as infrastructure for Internet-based messaging
IPLP Software Requirements Specification
Section of Software Requirements Specification (SRS) maintained for developers and product managers during design phase for new release of Internet-based messaging software server package
Address Parsing in IPLP
A detailed technical diagram followed by a series of detailed narratives that reference the diagram as they explain step by step how this messaging server parsed the destination addresses of the messages it sent and received
IPLP Protocol Commands for Messaging
A reference guide for the line protocol used by "IP LaunchPad", a server suite for messaging (fax, voice, etc.) over IP, with accompanying end-user applications. Just slightly ahead of its time, but not far enough.
Security
Getting Started with OpenID Connect
A brief introduction to writing code to Authorize a Subscriber's connection using the Firm's OpenID resource
Overview of Oauth 2.0
Tech note (web-based) documenting oauth implementation for outside developers writing to content provider's APIs
Development
Release Notes: Aleri Streaming Platform
Sample Release Notes detailing latest release of CEP server software for admins and developers in the communications field
Installation Guide: Aleri Streaming Platform
Instructions for admins installing Complex Event Processing server software
Internet Gateway SDK User's Guide
Section of complete documentation of Software Development Kit for server software that facilitated IP messaging, using C++-based API
Overview of Oauth 2.0
Tech note (web-based) documenting oauth implementation for outside developers writing to content provider's APIs
IP Launchpad Software Requirements Specification
Section of Software Requirements Specification (SRS) developed for developers and product managers during design phase for new release of Internet-based messaging software server package
Information Technology Standards and Architecture
The first part of a high-level explanation of considerations for building an information architecture
Getting Started with OpenID Connect
A brief introduction to writing code to Authorize a Subscriber's connection using the Firm's OpenID resource
Trading Platform Vision Document
A brief section from one of the design documents written for the formal planning stage of an enterprise-level financial infrastructure project
How To Add a Registration Form to your Website
Targeted instructions telling web developers how to add a link to an e-commerce company's registration service to their webpage
IPLP Protocol Commands for Messaging
A reference guide for the line protocol used by "IP LaunchPad", a server suite for messaging (fax, voice, etc.) over IP, with accompanying end-user applications. Just slightly ahead of its time, but not far enough.
maketecheasier tutorial: Getting Started With Markdown
A screencast produced for "make tech easier" introducing the basics of the Markdown markup system. I wrote the script, produced the video, and recorded the voiceover.