DOCUMENT PORTFOLIO

DOCUMENT PORTFOLIO
API GUIDE
PROJECT  API User Guide
CLIENT  U.S. Federal Agency
TOOLS  Word • HTML
FULL VIEW  View Online
NOTES   
This 3,100-word document and online web help portal was created as a user guide for an AI Data Robot.

As a result of multiple API users and frequent new users, the client requested that I create an online HTML version of the API User Guide. In addition to this guide, there are in-app context-sensitive help tip tools for every function in the API. (Note: I also created the API software and all JSON data transport modes, AI parameterization and AI algorithms.)




TOOLTIPS
PROJECT  Technical Article
CLIENT  Techwriter - Poland
TOOLS  Word • HTML • Markdown
FULL VIEW  View Online
NOTES   
This 1,780 word blog was created as a request from a technical writer and developer colleague for publishing on a Polish Technical Writer site.

This article focuses on the use of Context Sensitive Help — CSH (tooltips). I provide an example how CSH could improve existing operations and an example of how I integrated CSH into my code for a data analysis project. I also show how to configure CSH for a complete on-demand technical document using JavaScript and a doc-as-code framework.



ANALYSIS
PROJECT  Data Analysis & Presentation
CLIENT  Federal Government & IT Consultant
TOOLS  ColdFusion • PHP • SQL • Fusion Charts
FULL VIEW  View Online
NOTES   
This 3,126 word data analysis and training series presentation and document were created as a request from a federal government customer. The presentation covers recent COVID trends in South America for data presentation primarily to senior Management.

The information included in the presentation is part of a series that I created for a regional commercial customer; I augmented the data with current COVID related data to give the presentation relevance to a broad audience.

I created all content and analyses for this presentation as well as all data curation, SQL queries, charts, and graphics.



TECH SPECS
PROJECT  Technical Specifications
CLIENT  Commercial & Government
TOOLS  Word • HTML • FusionCharts
FULL VIEW  View Online
NOTES   
This document is a 5-page 2200-word technical specifications summary for the Pulse performance app.

This specification document is designed for app users as well as cyber security officials and executive management. Specifically included are guides for app "how to" tasks and security controls and app framework architecture.




AI-HUMAN
PROJECT  Technical Article
CLIENT  Public
TOOLS  Word • Chat GPT 4 • HTML
FULL VIEW  View Online
NOTES   
This 1,340 word blog was created as a request from a colleague in response to a TV news report about AI replacing humans in the workforce.

I put AI to the test in a face-to-face competition, with me, to determine who is better and faster completing a given set of tasks. I try to answer my colleagues question with experience and insight. I empower the reader to be the judge and jury in my case.



REMOTE
PROJECT  Technical Article
CLIENT  Public Interest Group
TOOLS  Word • HTML
FULL VIEW  View Online
NOTES   
This 1,780 word article was created for a WFH HR public interest group.

I started my IT company as a remote organization. I provide my experience and perspective working remotely and managing distributed teams assigned to large Federal Government projects and other multinational projects.



FINANCIAL
PROJECT  Commercial Proposal
CLIENT  Commercial Bank
TOOLS  Word • HTML • PDF
FULL VIEW  View Online
NOTES   
This document is a 32 page 10,800-word technical proposal for a commercial bank customer.

When I wrote this proposal, I included robust security detail required for payment processing between the bank's customers and other financial institutions. This technical proposal leveraged our existing mobile payment platform and software; one of the first mobile payment software products in the region.




DESIGN
PROJECT  Design Document & Application Plan
CLIENT  U.S. Federal Agency
TOOLS  Word • HTML
FULL VIEW  View Online
NOTES   
This 6,300-word document was created as an application design plan for the dual purposes of detailing the existing as-built software application and as a technical guide for future development.

The design document also includes a comprehensive data dictionary to aid future enhancements as well as reference to the online Administrator Group and User Management portal help files (available to authenticated administrators).




NEWS REPORT
PROJECT  News Report
CLIENT  Research Organization
TOOLS  ColdFusion • PHP • HTML • Fusion Charts
FULL VIEW  View Online
NOTES   
This web portal is a slight departure from my normal software-focused technical writing. Specifically, I conducted all the background research and data analysis for this 1,028 word report and wrote the piece in a news article format as specified by the client.

In addition to the research for this news article, I also programmed the software, display layers, and data curation for all the data graphs and charts in the article. One of the key properties of the charts and graphs and icons is the roll-over feature which provides more context sensitive information for each entity.

This interactive web portal demonstrates my flexibility with technical writing and communication.




TRAINING
PROJECT  Training Manual
CLIENT  U.S. Federal Government
TOOLS  Word • HTML
FULL VIEW  View Online
NOTES   
This manual is a 3,130 word technical document which I created as a training guide for use by USDA IT staff when training users and customer support staff.

The training manual is used in conjunction with an online presentation demonstrating the key areas of the application. Additionally, I conducted multiple well-received initial training sessions in Washington, DC, Denver and Colorado Springs, CO for senior IT and program managers and software support staff.




HELP GUIDE
PROJECT  Online Help Guide
CLIENT  Commercial Printing Company
TOOLS  HTML • Photoshop
FULL VIEW  Online Web Guide
NOTES   
This 2,658 word online help guide was built to provide a large and widely distributed user base with a simple self-help tool. The guide is presented in a Help Card format where each card captures a discrete application function. This format helps users quickly find the content needed to complete a function.

The help guide has been well accepted by users and management and is included as part of the new user onboarding process.