Writing

Writing is what I do for a living and this portfolio is the bulk of the website

Although most of my experience is in financial services organizations, my experience includes a major law firm, and a jewelry company. There are common threads for all of my clients, whether it is a simple instruction for a patch installation, a complex server build, a mainframe SOP, or an ISO standard.

Basic Rules

  • Decide on a format for all the documents and stick to it
  • Keep the appearance simple
  • Define an Approval Process
  • Define An Audience or a Purpose
  • List Related Documents and preferably provide links to each of them
  • Repurposing - always be ready to combine different sections of different documents to form new ones without proofreading for position of every element on the page
  • Security - I go into this in detail on my Adobe page - never let anyone change an original
  • Publication - Always prepare for multiple distribution formats
  • Use the best tool for the job

Types of Documentation

Most of my clients have viewed documentation as an 'afterthought' - they need it for the auditors, the SEC, or some other form of due diligence. Afterthought involves lots of of scheduling for interviewing, drafting, reviewing, approving. Everyone has to agree that 'putting it down on paper' is a good idea and in their best business interests. Getting that done is very difficult. Defining an audience or a purpose and an approval process makes consensus a bit easier.

Then there's documentation as a 'process.' That's just what it sounds like...changes twice a day maybe more maybe less. This is where I have the most fun. Deadlines are usually very tight and almost always broken. I have the opportunity to use what I know - 1,000 cache buffers on a server is very low, it should be 10,000 or more. Document design, repurposing, security, and multiple publication media are critical.

Repurposing ONE document to multiple output formats saves time, money, errors, and cuts down on the amount of software needed for multiple output. Using Adobe FrameMaker, I published the Telecommunications document to print .pdf format, html, dhtml and xml.

FrameMaker 7.0 / Quadralay

Telecommunications for Print

Telecommunications for Web The numbers next to the headers correspond to the Table of Contents of the print document

Telecommunications for Web - DHTML A navigation bar appears on the top and bottom of each page and I was able to split the long html document into single pages.

Telecommunications for Web - XML An xml version of this document. Older browsers will not be able to display this document.

My consulting business has given me an opportunity to cover almost every operating system used in business. My portfolio starts below:

Operating Systems

Solaris

Unix

Production Control - mainframe SOPs -Sections of this document have been deleted to conserve space. The TOC lists the contents of the orignal document.

Windows 2000 Server

Windows NT Server Build

Windows NT Server Upgrades

Novell Server Build

My 'process' documentation is special to me. The first link is to a laptop build instruction that was sent to upstate New York on a Friday afternoon. Over that weekend, technicians were hired and with little or no training, close to 1,000 latops were built and QA tested in 72 hours.

Laptop Build

The deadlines were tight but my workstation build did not have the drama of the laptop.

Workstation Build

User Documentation

I have prepared user documentation for proprietary software.

User Documentation

Training Course

My law firm client found my technical background interesting and asked that I research, write, and teach a class on Basic Networking. Although I was employed by their Quality Assurance department, many attendees were trainers.

Basic Networking

The law firm also needed diagramming of their server setup. What do we own, where is it, and what is it used for. Visio 2000 Professional provided us with actual graphics of servers from every manufacturer along with backup devices and a host of other graphics. For the Director of IT, I did a diagram to establish mail flow.

Diagrams and Forms

Mail Flow Diagram

Adobe Acrobat is a weapon of choice, I talk about its security capabilities on my Adobe page. Another one of its greatest strengths is forms creation.

Adobe Form

Page Layout and Special Effects

I have done some work in page layout either for a class or on my own. I did both of these in InDesign 2.0, Adobe's answer to QuarkXpress. The reviewers are right, I took classes in Quark and I just never really 'got it.' - InDesign has Quark beaten.

Time Magazine Article

Colors

Flash

Attached are a few Flash creations. One is an .exe file.

Morph

Greeting Card

Swallow - this is the executable file

Finally, type with special effects done in Adobe Illustrator

Illustrator

Click Here to Return to my Home Page

 

© Lantastik Consulting, Inc