Technical Writer - API Documentation

Bloomberg; New York (NY); On-site; USD 130,000 - 160,000; Full time

Benefits offered by this job

Benefits package

401(k) match

Life insurance

Wellness programs

Job summary

Bloomberg’s Product Documentation and User Assistance group seeks a technical writer to create API documentation for Bloomberg’s developer clients, including quick starts, conceptual explanations, tutorials, installation guides, and tech specs.

You will drive the scope and direction of deliverables, manage projects independently, and participate in setting authoring requirements for the engineers who build our CMS and authoring tools.

Qualifications

• 3+ years of technical writing for a developer audience, including API docs.
• Deep knowledge of API documentation best practices.
• Ability to read and understand programming languages (preferably Python) and test code samples.
• Strong writing style for a client audience with flexible tone.
• Ability to switch voices for developers and business decision makers.
• Proven project management skills with multiple timelines.
• Experience maintaining large documentation and content structures.
• Track record of collaborating with staff at all levels.
• Drive to build skills across technical and financial domains.

Responsibilities

• Research, write, and iterate on client-facing API documentation for an evolving product.
• Organize content to foreground essential information for readers.
• Adhere to style guidelines and extend them for bespoke content.
• Manage a high volume of projects with cross-functional stakeholders.
• Leverage API experience to evolve writing styles and tools, including AI.

Skills

API documentation

Technical writing

Python familiarity

Content strategy

Project management

Tools

DITA

HTML

Markdown

Git workflows

Job description

Location

New York

Business Area

Engineering and CTO

Reference #

10052874

Description & Requirements

Accurate, strategic, creative -- and fast. We help clients get the most from Bloomberg’s vast suite of products, educating and informing them about the tools that help them do their jobs.

Bloomberg’s Product Documentation and User Assistance (PDOC) group is a centralized team of technical writers creating user assistance materials that span business areas across the financial markets. We partner with Product, Technology, and UX teams to investigate requirements in an energetic environment characterized by frequent product updates and quick time-to-market. Our writers have the skills to solicit business needs, jump quickly from discovery to draft, and shift seamlessly between writing styles for different deliverables.

We take pride in being a collaborative team of 30+ writers that values peer editing, an iterative writing process, and cooperative idea generation. We work with style guides to create essential documentation with a unified, professional voice. Though we move quickly and strive to perfect the art of balancing competing priorities, we put a premium on quality — both of writing and ideas.

What's the role?

We're looking for a writer with top-notch writing skills and a strong aptitude for explaining code. Our Enterprise Data technical writers work with colleagues in Product, Customer Support, and Engineering to create API documentation for Bloomberg's developer clients, including quick starts, conceptual explanations, tutorials, installation guides, and tech specs. Candidates should expect to drive the scope and direction of documentation deliverables, manage projects independently, and participate in setting authoring requirements for the engineers who build our CMS and authoring tools.

We'll Trust You To

• Research, write, and iterate on client-facing API documentation for an ever-evolving product.
• Employ logical content strategy and organization to forefront essential information and make content easy for readers to consume.
• Adhere to style guidelines for a suite of standard deliverables, and work creatively to extend those guidelines for bespoke content.
• Manage a high volume of projects and priorities independently, in close collaboration with another writer and multiple cross-functional stakeholders.
• Draw on your experience of working with APIs to generate creative ideas for evolving our styles, processes, and tools - including our team’s use of artificial intelligence.

You Need To Have

• 3 or more years of technical writing experience for a developer audience, including experience writing API documentation.
• Deep knowledge of API documentation-writing best practices.
• The ability to read and understand widely-used programming languages (preferably Python) and work with/test/validate code samples.
• Strong, flexible writing skills appropriate for a client audience, with the ability to strike a conversational or formal tone depending on the deliverable.
• The ability to switch between voices to address both developers and business decision makers, providing both technical content and benefit-focused materials.
• Tested project management skills, including strength in managing and organizing multiple projects with variable timelines.
• Experience maintaining a large amount of documentation for a product and establishing new content structures within it.
• A proven track record of success interacting with all levels of staff and management, including business specialists, customer support, development teams, and senior management.
• The drive to gain knowledge and build skills across both technical and financial domains.

We'd Love To See

• Direct software development experience working with APIs.
• Editing experience.
• Demonstrated initiative in innovating and implementing workflow, process, and technical solutions.
• Aptitude for strong visual display of information and image production as part of effective content design.
• Experience with DITA, HTML, or other online authoring tools.
• Experience with git workflows and writing documentation in Markdown.
• A working understanding of financial markets.

Salary Range = 130,000 - 160,000 USD Annual + Benefits + Bonus

The referenced salary range is based on the Company's good faith belief at the time of posting. Actual compensation may vary based on factors such as geographic location, work experience, market conditions, education/training and skill level.

We offer one of the most comprehensive and generous benefits plans available and offer a range of total rewards that may include merit increases, incentive compensation (exempt roles only), paid holidays, paid time off, medical, dental, vision, short and long term disability benefits, 401(k) +match, life insurance, and various wellness programs, among others. The Company does not provide benefits directly to contingent workers/contractors and interns.

Discover what makes Bloomberg unique - watch our for an inside look at our culture, values, and the people behind our success.