Shawn McGowan Shawn McGowan

MARINE ELECTRONICS TECHNICAL DOCUMENTATION, Garmin

MARINE ELECTRONICS TECHNICAL DOCUMENTATION
Garmin International | 2020-2024

THE CHALLENGE
Garmin's marine electronics division produces sophisticated navigation, fishfinding, and trolling motor systems for recreational and commercial marine markets. These systems integrate complex electro-mechanical components, software interfaces, and wireless connectivity requiring documentation that serves diverse user skill levels—from first-time boat owners to professional fishing guides.

The Force trolling motor line and related marine products required documentation that would:
• Enable end users to install, configure, and operate advanced marine electronics
• Support marine dealers and technicians performing installation and service
• Explain integration with other Garmin marine systems (chartplotters, sonar, autopilot)
• Provide troubleshooting guidance for common technical issues

MY APPROACH
I created comprehensive documentation supporting the complete product lifecycle:

End-User Documentation:
• Developed owner's manuals with installation procedures, configuration guides, and operational instructions
• Created quick start guides for out-of-box setup and first-use scenarios
• Wrote troubleshooting sections organized by symptom with clear resolution steps
• Produced online help content and video script outlines for digital support channels

Technical Service Documentation:
• Authored service manuals for authorized dealers and technicians
• Documented diagnostic procedures and repair workflows
• Created wiring diagrams and system architecture documentation
• Maintained parts lists and service bulletins for field updates

Product Integration:
• Documented system integration procedures across Garmin's marine product ecosystem
• Explained connectivity (NMEA 2000, Wi-Fi, Bluetooth) setup and troubleshooting
• Created configuration guides for advanced features requiring multi-device coordination

Content Management:
• Used xMetal for structured documentation development
• Maintained documentation through product updates and firmware releases
• Coordinated translations and localization for international markets
• Managed documentation version control tied to product software releases

OUTCOMES
• Delivered documentation supporting successful product launches across marine electronics portfolio
• Reduced customer support contact rates through comprehensive troubleshooting documentation
• Received positive feedback on service manual clarity and technical accuracy
• Maintained documentation quality through multiple product generations and software updates

SKILLS DEMONSTRATED
• Consumer and technical service documentation
• Complex electro-mechanical system documentation
• Multi-device integration documentation
• xMetal expertise
• Product lifecycle documentation management
• Multi-audience content strategy

Read More
Shawn McGowan Shawn McGowan

FDA-REGULATED MEDICAL DEVICE DOCUMENTATION, Terumo BCT

PROJECT 2: FDA-REGULATED MEDICAL DEVICE DOCUMENTATION
Terumo BCT | 2017-2020

THE CHALLENGE
Terumo BCT manufactures blood component and cellular technology systems regulated by the FDA. Documentation for these systems must serve multiple audiences—clinical operators, biomedical technicians, and regulatory auditors—while maintaining strict compliance with FDA 21 CFR Part 820 quality system regulations. TerumoBCT acquired Harvest, which had inconsistent and inaccessible documentation.

The Harvest BMAC system and related blood and adipose centrifugal devices required comprehensive documentation that would:
• Guide clinical operators through complex procedures with zero tolerance for error
• Support biomedical technicians performing maintenance and troubleshooting
• Satisfy FDA regulatory requirements for device labeling and instructions for use
• Maintain clear traceability for quality management system audits

MY APPROACH
I developed multi-layered documentation suited to the high-stakes healthcare environment:

Regulatory Compliance:
• Ensured all documentation met FDA requirements for medical device labeling
• Followed ISO 13485 quality management system guidelines
• Maintained document control procedures including version tracking, change history, and approval workflows
• Coordinated with Quality Assurance, Legal, and Regulatory Affairs teams for documentation review and approval

Audience-Specific Content Development:
• Created operator manuals with step-by-step clinical procedures, warnings, and precautions
• Developed service manuals for biomedical technicians with troubleshooting flowcharts and maintenance schedules
• Wrote quick reference guides for point-of-care use in clinical settings
• Produced training materials supporting clinical education programs

Risk Mitigation:
• Collaborated with clinical affairs and risk management teams to identify potential use errors
• Implemented clear hierarchical warning systems (DANGER, WARNING, CAUTION) throughout documentation
• Used structured authoring tools (Arbortext) to ensure consistency and completeness
• Tested procedures through user validation studies to identify documentation gaps

OUTCOMES
• Successfully supported FDA submissions and regulatory audits with zero documentation-related findings
• Documentation approved by clinical users for clarity and usability in real-world healthcare settings
• Contributed to quality system that maintained ISO 13485 certification
• Reduced operator error incidents through improved warning placement and procedure clarity

SKILLS DEMONSTRATED
• FDA-regulated medical device documentation
• Multi-audience technical communication
• Risk-based documentation approach
• Quality management system compliance (ISO 13485, 21 CFR Part 820)
• Structured authoring and document control
• High-stakes accuracy and precision writing

Read More
Shawn McGowan Shawn McGowan

PAYMENT PROCESSING API DOCUMENTATION, Visa

PROJECT 1: PAYMENT PROCESSING API DOCUMENTATION
Visa Inc. | 2015-2017

THE CHALLENGE
Visa's payment processing APIs enable developers to integrate secure transaction processing into their applications. These APIs handle sensitive financial data and must comply with PCI DSS standards while serving a technically sophisticated audience—developers implementing payment solutions for the first time.

Documentation Structure:
• Created a consistent template for all API endpoints (request/response formats, parameters, authentication, error codes)
• Developed a comprehensive getting-started guide with authentication flow examples
• Built a reference section for error codes with troubleshooting guidance
• Documented security best practices and PCI compliance requirements

Cross-Functional Collaboration:
• Worked directly with payment processing engineers to understand technical implementation details
• Partnered with the security team to ensure accurate representation of compliance requirements
• Collaborated with developer relations to identify common integration pain points
• Incorporated feedback from external developers during beta testing phases

Quality Assurance:
• Tested all code examples in development environments to ensure accuracy
• Validated API calls and responses matched actual system behavior
• Maintained version control for documentation updates tied to API releases

OUTCOMES
• Reduced developer support tickets related to API integration
• Improved time-to-first-successful-API-call for new developers

SKILLS DEMONSTRATED
• API documentation for technical audiences
• Complex technical concept simplification
• Security and compliance documentation
• Cross-functional stakeholder management
• Developer-focused content strategy

Read More