Technical Author

Technical Author

In this role, you will be responsible for creating clear, concise, and user-friendly documentation for our data flows, systems, and processes. You will collaborate closely with software engineers, product managers, and other stakeholders to translate complex technical concepts into accessible materials for both internal and external audiences.

Key Responsibilities

• Documentation Development:

  Create and maintain high-quality technical documentation, including user guides, API documentation, knowledge bases, system architecture overviews, and process manuals.

• Collaboration:

  Work closely with engineers, product teams, and UX designers to gather insights and ensure documentation aligns with product functionality.

• Content Strategy:

  Develop structured content strategies that improve knowledge sharing and efficiency within the department.

• Version Control & Maintenance:

  Ensure documentation remains up to date with evolving technology, product enhancements, and best practices.

• Technical Writing Standards:

  Establish and maintain best practices for technical writing, including style guides, templates, and documentation tools.

• User-Centered Approach:

  Adapt writing style and format based on target audiences, ensuring clarity for developers, business users, and end customers.

• Training & Support:

  Assist in creating onboarding materials and training guides for internal teams and customers.

• Tool Utilization:

  Use documentation tools such as Markdown, Confluence, Git, and other content management systems to develop and publish content efficiently.

Required Skills & Experience

• Proven Experience:

  Minimum 5 years of experience as a technical author, technical writer, or similar role within a technology-driven environment.

• Technical Understanding:

  Strong grasp of software development concepts, APIs, cloud computing, databases, and enterprise systems.

• Writing & Communication:

  Excellent writing, editing, and proofreading skills with the ability to simplify complex topics.

• Tools & Technologies:

  Experience using documentation tools such as Markdown, Confluence, Git, DITA, XML, or similar.

• Collaboration & Agile Experience:

  Comfortable working in Agile environments and collaborating with cross-functional teams.

• Attention to Detail:

  Ability to meticulously organize and present information in a structured and logical manner.

• Problem-Solving:

  Strong analytical and problem-solving skills to ensure documentation addresses real-world user needs.

Preferred Qualifications

• Familiarity with programming languages (e.g., Python, Java, JavaScript) and Data Warehousing techniques and ETL concepts is a plus.
• Experience documenting APIs using OpenAPI (Swagger) or Postman.
• Knowledge of DevOps processes and CI/CD pipelines.
• Certification in Technical Writing or a related field is beneficial.