Rian Murphy - Technical Writing Samples by Document Type
Scroll down or follow one of these links for samples for the following types of Documents:
Users' Guides
Installation Guide: Aleri Streaming Platform
Instructions for admins installing Complex Event Processing server software
LMA Pricing Portal Quick Reference Guide
Graphic one-sheet documentation for end-users processsing load information for financial firm
Broadcast List Manager Guide (User Guide)
User Guide for admins using GUI to configure messaging user accounts for Internet-based messaging sofware package
Application Note: Message Tracker for IPLP
An end-users' guide for administrators tracking messages on the IPLP messaging server
Booking a New Loan Overview
Step-by-step guide for processors entering loan information into financial company's mainframe, developed using Info Mapping technique
Overview of Oauth 2.0
Tech note (web-based) documenting oauth implementation for outside developers writing to content provider's APIs
API/SDK Reference
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
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
Design Documents
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
Information Technology Standards and Architecture
The first part of a high-level explanation of considerations for building an information architecture
Glossary
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
High-Level Documentation
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
Information Technology Standards and Architecture
The first part of a high-level explanation of considerations for building an information architecture
Software Requirements Specification
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
Technical Diagrams
Overview of Oauth 2.0
Tech note (web-based) documenting oauth implementation for outside developers writing to content provider's APIs
Business Process Flow: Procure-To-Pay
Detailed subset of flowchart set documenting e-commerce produce-to-pay processes -- swimlane flowcharts using Business Process Modeling Notation (BPMN)
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
Training Guide
Sale Process Training
PowerPoint presentation used by trainers instructing new producers of online sales e-commerce site
Information Mapping Procedure
Booking a New Loan Overview
Step-by-step guide for processors entering loan information into financial company's mainframe, developed using Info Mapping technique
Job Aid
LMA Pricing Portal Quick Reference Guide
Graphic one-sheet documentation for end-users processsing load information for financial firm
PowerPoint deck
Sale Process Training
PowerPoint presentation used by trainers instructing new producers of online sales e-commerce site
Release Notes
Release Notes: Aleri Streaming Platform
Sample Release Notes detailing latest release of CEP server software for admins and developers in the communications field
Visio document
Business Process Flow: Procure-To-Pay
Detailed subset of flowchart set documenting e-commerce produce-to-pay processes -- swimlane flowcharts using Business Process Modeling Notation (BPMN)
Video screencast
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.