Ron Santos’s Portfolio

I leverage my extensive Business Analyst experience to write correct, clear, and on-time software documentation, and below are examples of my work. For more information on me, see my LinkedIn profile at www.linkedin.com/in/ron-santos.

Project	GanttProject User Guide
Date	December 2019
Description	I wrote this 27-page-long user guide for the final project in a graduate-level course on software documentation at Northeastern University. The user guide is for GanttProject, which is an open-source software application for project management.
Intended Audience	GanttProject users
Software Used	Microsoft Word
File	GanttProject User Guide.pdf

Project	Pixelitor Online Help System Using MadCap Flare
Date	December 2019
Description	I created this online help system using MadCap Flare for the final project in a graduate-level course on online documentation at Northeastern University. The help system is for a subset of the functionality in Pixelitor, which is an open-source graphical editor for bitmap image files. There are two files in the last row of this table. The first file contains four pairs of screenshots: the first of each pair is a sample topic in MadCap Flare, and the second is the associated output in a web browser. The second file is the complete help system. To view it, unzip the file, and then open the file Default.htm in a web browser.
Intended Audience	Pixelitor users
Software Used	MadCap Flare
Files	Pixelitor Help System Sample Screenshots.pdf Pixelitor Help System.zip

Project Title	Edit Software Integration Document and Quick Start Guide
Date	March 2021
Description	For a freelance editing project for a graduate-level technical editing course at Arizona State University, I comprehensively edited two documents for a software company named TCPWave (www.tcpwave.com). The first was an 18-page-long software integration document that describes to customers how to integrate TCPWave’s main product with a workflow product from a company named ServiceNow. The second was a 27-page-long quick start guide that was based on an 877-page-long user guide for TCPWave’s main product. I substantially edited both documents and improved their accuracy, completeness, organization, clarity, and format. For some of these improvements, I drew upon documentation at ServiceNow’s website and TCPWave’s user guide. A screenshot of the professor’s highly complimentary assessment of this project, the original version of the software integration document, and the final version after I edited it are provided below. TCPWave’s quick start guide is proprietary, so it is not available here.
Audience	TCPWave’s customers
Software Used	Microsoft Word
Files	Professor’s Assessment of Project.png TCPWave Integration with ServiceNow - Original.pdf TCPWave Integration with ServiceNow - After Editing.pdf

Project	Pencil2D Video Tutorial
Date	February 2020
Description	I created this video tutorial as part of the final project for a graduate-level course on software documentation at Northeastern University. The seven-minute tutorial is for a subset of the functionality in Pencil2D, which is an open-source software application for creating 2D animation.
Intended Audience	New Pencil2D users
Software Used	Snagit screen recorder Adobe Premiere Elements video editor Audacity audio editor
File	Pencil2D Tutorial.mp4

Project	Pencil2D Quick Reference Guide (QRG)
Date	February 2020
Description	I wrote this QRG as part of the final project for a graduate-level course on software documentation at Northeastern University. The two-page guide is for Pencil2D, which is an open-source software application for creating 2D animation.
Intended Audience	Pencil2D users
Software Used	Microsoft Word
File	Pencil2D QRG.pdf

Project	Pencil2D White Paper
Date	February 2020
Description	I wrote this white paper as part of the final project for a graduate-level course on software documentation at Northeastern University. The paper is for Pencil2D, which is an open-source software application for creating 2D animation, and its goals were to inform and persuade prospective Pencil2D users.
Intended Audience	Prospective Pencil2D users
Software Used	Microsoft Word
File	Pencil2D White Paper.pdf

Project	User Guide in DITA Structured Format
Date	June 2019
Description	I created this user guide for the final project in a graduate-level course on structured documentation at Northeastern University. For this project, I converted 29 pages from three related sections in a user guide in a PDF file to 30 DITA topics and an associated DITA bookmap. The file in the last row of this table contains the table of contents and screenshots of two example topics, including the DITA tags in them. Note: The user guide was for a DNS-related feature in VitalQIP, which has been discontinued, for which I had written the software requirements.
Intended Audience	VitalQIP users
Software Used	Oxygen XML Editor
File	VitalQIP ENUM Manager User Guide Screenshots.pdf

Project	Software Requirements for Three DNS-Related Features
Date	2015 and 2016
Description	These three documents contain a sample of the software functional requirements that I created for three features that I was responsible for at a previous job. These features were all for the same product and are as follows: • Analytics and Reporting • Domain Name System Security Extensions (DNSSEC) • DNS Response Policy Zones (RPZ) Although technical writers normally do not write software requirements, these documents show that I am experienced at creating documents that contain complicated technical information. Note: Identifying information, including the name of the company and product, was removed from these files. Also, the product has been discontinued.
Audience	Developers, testers, and technical writers
Software Used	Microsoft Word VersionOne (a competitor of Jira)
Files	Analytics and Reporting Tier 2 Reqts.doc DNSSEC Tier 2 Reqts.doc DNS RPZ Tier 2 Reqts.doc