Technical Doc Writer, Contractor

$104,000 - $124,800/Yr

Sentry - San Francisco, CA

posted 4 months ago

Full-time - Entry Level
San Francisco, CA
10,001+ employees
Insurance Carriers and Related Activities

About the position

Sentry is seeking a Technical Documentation Writer Contractor to join our documentation team. In this role, you will be responsible for writing and maintaining comprehensive documentation that assists developers in utilizing Sentry's tools effectively. Your daily tasks will involve structuring both new and existing content to enhance navigability and user experience. Collaboration is key in this position, as you will work closely with engineering, product, and design teams to ensure that the documentation aligns with the overall product strategy and meets user needs. Given Sentry's commitment to open-source, a portion of your time will also be dedicated to engaging with our open-source community, reviewing their contributions, and integrating their feedback into the documentation on platforms like GitHub. Your responsibilities will include managing the documentation process, which encompasses version control and publication using tools such as Markdown and Git. You will conduct thorough reviews of existing documentation to enhance clarity, accuracy, and usability. Additionally, you will contribute to the development and execution of a user-centric documentation strategy that aligns with Sentry's product goals. This role is ideal for someone who enjoys writing, editing, and updating technical documentation tailored for a software developer audience, including product guides, API documentation, tutorials, and best practices. You will also gather and incorporate feedback from both internal and external users to continuously improve the documentation.

Responsibilities

  • Manage the documentation process, including version control and publication using documentation tools and platforms such as Markdown and Git.
  • Conduct thorough reviews of existing documentation to improve clarity, accuracy, and usability.
  • Contribute to the development and execution of the documentation strategy, ensuring content is user-centric and aligns with the overall product strategy.
  • Write, edit, and update existing technical documentation for a software developer audience, including product and SDK guides, API documentation, tutorials, and best practices.
  • Work closely with engineers, product managers, and support teams to gather information and ensure accuracy.
  • Gather and incorporate feedback from both internal and external users to continuously improve the documentation.

Requirements

  • Bachelor's degree or equivalent.
  • Excellent written English skills and a demonstrated ability to explain complicated technical concepts clearly.
  • 4+ years of relevant experience; bonus if it's in software, platform engineering, or documentation-writing.
  • High-level understanding of the software development process.
© 2024 Teal Labs, Inc
Privacy PolicyTerms of Service