Staff Technical Writer

AppDirect

  • Full Time

About AppDirect

AppDirect is the leading cloud service marketplace company dedicated to revolutionizing the way businesses run. We offer a cloud service marketplace and management platform that enables companies to distribute digital services. The global network of AppDirect-powered marketplaces allows businesses to find, buy, and manage the best applications the cloud has to offer.

With our award-winning platform, service providers can launch a state-of-the-art online application store within a matter of weeks, while developers can integrate once and make their software available across multiple marketplaces worldwide. Our products offer more advanced features and tools than any other competitive solution, putting AppDirect at the forefront of the rapidly evolving market for cloud-services delivery.

The Technical Documentation team is a lean, agile team that works closely with product, engineering, marketing, and account management teams to produce high-quality documentation for our customers. We are the go-to source for knowledge on all parts of the platform. We build out documentation infrastructure and processes for scaling for our growing customer base and rapid development lifecycle. 

About You

AppDirect is looking for an experienced Staff Technical Writer to produce high-quality developer documentation to help our customers integrate their systems with our platform using REST APIs and JavaScript libraries.

The primary tasks entail:

  • Testing REST and GraphQL APIs

  • Creating “recipe”-style API guides

  • Reviewing API descriptions in the source code

  • Working with development teams to update the current API reference documentation

In addition to these tasks, it will be necessary to produce guides or update help topics for our user interface as well.

As a Staff Technical Writer, you are able to work independently as part of a larger group. You will work with one or more product teams to define and scope documentation requirements, establish deadlines, and deliver documentation on time. You can learn highly technical concepts quickly and can explain them clearly and concisely.

You are a highly technical writer, strongly motivated to create the right content for excellent developer experiences. This role requires both diving deep on technical details and holding a strategic view of how our docs can best work together to support our platform’s success. You may write developer documentation from scratch or edit and bring together various content resources from SMEs. At times you will collaborate on shared projects with other writers, while also independently planning and executing on your own content deliverables.

What you'll do and how you'll make an impact

  • Work closely with Product Managers, Developers, QA, and our Platform Success team to gain product knowledge to develop documentation

  • Produce accurate, well-organized, high-quality documentation

  • Do code reviews to ensure that API reference documentation adheres to established standards

  • Review UI text and error messages during the product development cycle

  • Document features for weekly release notes, as required

  • Do peer reviews of other writers’ work

  • Contribute to our internal writing style guide
     

What you'll need

  • University degree in English, Technical Writing, Computer Science, or equivalent, with 7+ years of technical writing experience

  • Excellent writing, editing, grammar, and verbal communication skills, and a strong attention to detail

  • Knowledge of best practices and methodologies related to creating documentation, including single-sourcing

  • Experience with authoring tools such as MadCap Flare, Author-IT, FrameMaker, RoboHelp

  • Experience with source control systems such as Git, Subversion, Perforce

  • Experience writing developer/system integration documentation

  • Experience working with development teams

  • Read code in at least one programming language.

  • Write highly readable API reference documentation from scratch.

  • Understand developers as customers.

  • Support multiple projects/features/teams concurrently.

  • Collaborate, include others in your decisions, recognize collaborators’ contributions, and leverage their strengths.

  • Develop trusted relationships with important stakeholders, including UX, PM, Support, Engineering, and Marketing.

  • Make data-driven content decisions.

Preferred Qualifications

  • Experience testing and documenting REST APIs

  • Write runnable code in at least one programming language

  • Write highly readable developer concept and task documentation from scratch

  • Basic knowledge of at least one programming language, such as JavaScript, Java, C#

  • Strong knowledge of MadCap Flare

  • Strong knowledge of HTML, XML, and CSS

  • Experience with bug tracking systems such as JIRA

AppDirect is the only end-to-end commerce platform for selling, distributing, and managing cloud-based products and services to succeed in the digital economy. The AppDirect ecosystem connects channels, developers, and customers through its platform to simplify the digital supply chain by enabling the onboarding and sale of products with third-party services, for any channel, on any device, with support. Powering millions of cloud subscriptions worldwide, AppDirect helps organizations, including Jaguar Land Rover, Comcast, ADP, and Deutsche Telekom connect their customers to the solutions they need to reach their full potential in the digital economy.

We believe that the unique contributions of all AppDirectors is the driver of our success. To make sure that our products and culture continue to incorporate everyone's perspectives and experience we never discriminate on the basis of race, religion, national origin, gender identity or expression, sexual orientation, age, or marital, veteran, or disability status.

At AppDirect we take privacy very seriously. For more information about our use and handling of personal data from job applicants, please read our Candidate Privacy Policy. For more information of our general privacy practices, please see AppDirect Privacy Notice: link: https://www.appdirect.com/about/privacy-notice

 

Job Overview