Technical Writer / Editor -

Job Detail

Job ID 147019

Job Description

Overview

Placement Type:

Temporary

Salary (USD):

$50-$60HR

Start Date:

01.15.2024

This is a part-time position, 10-20 hours a week.

Our client is seeking a skilled Technical Writer/ Editor to join their team and play a crucial role in enhancing the quality, accessibility, and comprehensiveness of our platform documentation as well as reviewing pull requests to ensure that contributions from our engineering and product teams align with our style guidelines. The Technical Writer/Editor will collaborate closely with product and engineering departments,to ensure that the documentation aligns with the evolving needs of novice and advanced users alike. This individual will also contribute to efforts to reorganize and optimize existing documentation to maximize discoverability and usability for potential and current users of the platform. The candidate’s primary focus will be on maintaining a consistent tone and style across our documentation, collaborating closely with contributors to identify and clarify any ambiguous language. Ideal candidate will have a background in machine learning.

Job Responsibilities:

Comprehensive Documentation: Create and maintain comprehensive, accurate, and accessible documentation for all aspects of the Domino platform, including installation, configuration, and usage. This documentation should cater to both novice and advanced users, providing clear and concise instructions.
Collaboration: Work closely with product and engineering teams to ensure that documentation and training materials accurately reflect the capabilities and features of the Domino platform. Collaboration will be essential to stay aligned with evolving platform enhancements.
Documentation Optimization: Reorganize the existing product documentation to enhance discoverability and usability. Focus on optimizing the content for new customer prospects and users, helping them understand the value of Domino and effectively use its features.
Gap Identification: Identify and address key documentation gaps by creating new content and leading efforts to involve subject matter experts from various departments, including PM, Design, and Sales Engineers. This includes conceptual overviews to explain the “why” behind features and detailed “how-to” content for successful platform utilization.
Content Ownership: Take ownership of the creation of critical documentation content and supervise, review, and edit content authored by other subject matter experts to ensure consistency, accuracy, and clarity.
Pull Request Review: Critically review pull requests for technical documentation, ensuring adherence to style guidelines.
Style and Tone Consistency: Maintain a consistent, casual yet informed, tone and style throughout all documentation, creating a cohesive experience for users.
Collaborative Editing: Work closely with engineers, product managers, and other contributors to refine and clarify documentation.
MLOps Workflow Familiarity: Utilize your understanding of MLOps workflows to ensure that documentation is accessible and written in the language of our primary user base, data scientists.
Quality Assurance: Conduct thorough checks for grammar, punctuation, and formatting inconsistencies.
Feedback and Guidance: Provide constructive feedback to contributors, guiding them in improving their technical writing skills.

Qualifications:

Bachelor’s degree in English, Technical Writing, Communications, Data Science, Software Engineeringor a related field.
Proven experience in technical writing or editing, with a strong focus on style guide development and implementation and information architecture.
Familiarity with docs-as-code workflows, ASCIIdocs and Git.
Familiar with MLOps workflow and the language commonly used by data scientists.
Excellent understanding of technical writing principles and style standards.
Strong analytical skills to identify patterns in writing errors and inefficiencies.
Exceptional communication skills, with the ability to convey complex guidelines in an understandable manner.
Detail-oriented with a strong focus on quality and accuracy.

The target hiring compensation range for this role is the equivalent of $50-60HR an hour. Compensation is based on several factors including, but not limited to education, relevant work experience, relevant certifications, and location. Additional benefits offered may include; medical health insurance and dental insurance, life insurance, and eligibility to participate in 401k plan with company match.

Other jobs you may like

Remote B2C Market Researcher
- @ Coople
- Milton Keynes