Training and Technical Communications Professional

grayta@gmail.com   608.516.8492


Software Documentation

Work-Order Tracking Software

In response to user feedback, I took the opportunity to redesign the manual when the documented software underwent major changes. To help users quickly navigate new screens and fields, I reduced text, increased graphics, and respresented all steps with numbered callouts.

Customer Software

I worked with graphic designers from the Marketing team to produce this customer-facing brochure to outline the procedures for accessing our company's internal business software. Since the audience was our customers and the instructions were few, I wanted to produce an approachable brochure rather than a manual.

Medical Device Software

This highly technical guide documents genetic-testing software for researchers. I worked closely with subject matter experts to ensure complete and accurate instructions.













Hardware Documentation

Assembly Instructions

Following Good Manufacturing Practices (GMP), this company required documentation that enabled assemblers to record their progress as they completed each series of steps.
I developed a 220-page assembly manual in nine weeks, designing the layout, interviewing subject-matter experts, and taking hundreds of photos. The full manual includes step-by-step instructions, and three appendices that contain cable-assembly specifications, the bill of materials, and assembly drawings.

Repair Instructions

Service technicians relied on these step-by-step instructions to replace a key part in the company's radiation treatment systems.

Troubleshooting

Troubleshooting documentation is among the most difficult to write. In a complex system, the source of the trouble could be hundreds of issues. I purposely chose not to use a flowchart for this document; it would imply that all or most of the potential causes were presented when, in fact, we knew only a subset of them.
http://tagray.com/Samples/guides.html
tagray.com
crawl=CC-MAIN-2020-05
5182
application/http; msgtype=response
sha1:CU5UOYSFPLB3CABVF36LOTLYSZHRP6TY
<urn:uuid:a178644f-7949-4436-b963-8df66a2fc744>
2020-01-19T08:16:14Z
108.217.37.79
text/html
sha1:RFWTLE43E5OVUESXDARUDP4HWZWCBTPK
<urn:uuid:1abc426c-8d40-4877-8a4a-2ad4496a6c39>
http://tagray.com/Samples/guides.html
response
<urn:uuid:05b80a81-b819-4b51-8421-75b0ff58e415>
isPartOf: CC-MAIN-2020-05
publisher: Common Crawl
description: Wide crawl of the web for January 2020
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-154.ec2.internal
software: Apache Nutch 1.16 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.1-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/