Technical Writer

Skills
API DocumentationDarwin Information Typing ArchitectureDesign ToolsMadcap FlareManualsOnline HelpProgramming Concepts
Role

What the job involves

The main requirements, responsibilities and hiring steps.

Requirements

  • Bachelor's degree in English, Technical Writing, Computer Science, or related field; OR 2-4 years of experience in technical writing, preferably in a software or SaaS environment
  • Strong writing, editing, and proofreading skills
  • Proficiency in documentation tools (e.g., MadCap Flare, DITA Framework)
  • Familiarity with markup languages (e.g., HTML, XML, Markdown)
  • Experience with version control systems (e.g., Git)
  • Ability to quickly grasp complex technical concepts
  • Ability to collaborate openly with others
  • Excellent time management and organizational skills

Nice to have

  • Experience with API documentation
  • Knowledge of agile development methodologies
  • Familiarity with content management systems
  • Basic understanding of programming concepts
  • Experience with graphic design tools

Day to day

  • The Technical Writer creates clear and concise technical documentation, including user manuals, guides, and API documentation for our SaaS products
  • Work closely with subject matter experts, engineers, and product managers to gather information and ensure the accuracy and clarity of content
  • Ensures all documentation is user-friendly and meets company standards
  • Stay updated on industry trends and best practices in technical writing