Search

Senior Technical Writer

BayOne Solutions
locationLehi, UT, USA
PublishedPublished: 6/14/2022
Education
Full Time

Job Description

Title - Senior Technical Writer.

Locations - San Jose, CA (Onsite/Hybrid)

Contract - 06 to 12 months + Possible Multiple Ext

Pay Rate - $70 to $73hr w2.


Objective: Establish a unified voice in our step-by-step learning experience for all products and services. Documentation should be clear, guided and iterative to self understand, implement and debug issues confidently and consistently - with usage of relevant modalities like text, images, diagrams, videos, etc.

These learning journeys require documentation upgrades:

User Onboarding: CDT Hub → Introduction Cards → Product & Technical Guides

Business Justification:

Scattered guides across technologies are hard to scale (10 - 20 guides)

Poor developer satisfaction score at eBay 70/100 (DX survey 2025)

Ensure coverage of all important user personas (analytics heavy)

Lacking modern, exhilarating and conversational style guide

Clarity and accuracy for AI-productivity (obsolete content)

Key Deliverables:

A) Create a Unified CDT Guide Template with info-architecture that will be used for all products and services. Template should highlight product overview/workflow/impact, Platform Capabilities, SDK Docs, How-Tos, etc. Give requirements to build it. Edwin (Engineer) will migrate content for all products and services.

B) Deliver 5+ High-Quality Technical Product Guides:

- Build a modular product guide homepage template that reflects product vision (expand cards, data facts, personas, call to actions) and design them for all products & services.

- Create a framework and style guide to organize the Product Overview details in one section which includes Introduction, 5-10 min demo, use-cases, platform capabilities, best practices, etc. Create 5-10 minute walkthrough demos or tutorials for all products & services.

- Rewrite these sections that are heavily used by developers or users who want to get started quickly with the product: SDK (integration, debugging, SLAs), How-Tos, and FAQs.

C) Standard Publish Process (input → Chat GPT Agent → output → review and sign-off)

Acceptance Criteria

Review and approvals from Tech, SME, PM & address feedback from 3 customers.

Time and Effort: Minimize the time it takes for CDT partners to navigate and consume key information.

Shared Asset Library for all content with versioning: Quick Walkthrough Demos, How-To Tutorials, Testimonial Cards, Images, Videos, etc.

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...