Syndigo - Information Developer - Software Documentation

Key Responsibilities :

Technical Documentation Development :

- Design, develop, and maintain technical documentation for Syndigos platforms, SDKs, APIs, and enterprise applications.

- Produce and manage content across multiple formats including HTML, Markdown, and XML using modern documentation frameworks such as MadCap Flare, Jekyll, or equivalent open-source tools.

- Create comprehensive REST/JSON API documentation using tools such as Swagger, Postman, or OpenAPI specifications.

- Validate documentation accuracy by setting up, configuring, and testing products in real runtime environments.

Information Architecture & Content Strategy :

- Define and implement information architecture standards to ensure scalability, consistency, and reusability of content across multiple documentation sets.

- Establish and maintain content templates, authoring guidelines, and documentation workflows for consistent style and technical accuracy.

- Collaborate with engineering and product management to ensure that documentation aligns with software releases, feature updates, and UX designs.

Quality & Review Processes :

- Perform self-checks, peer reviews, and technical validations to ensure clarity, accuracy, and adherence to documentation standards.

- Participate in usability testing of information deliverables and incorporate user feedback to continuously improve content quality.

- Contribute to improving UI/UX text elements such as GUI labels, tooltips, and error messages for better user experience.

Cross-functional Collaboration :

- Partner with developers, QA engineers, and product owners to gain deep understanding of system functionality, workflows, and dependencies.

- Actively engage in agile development processes to ensure documentation deliverables are synchronized with sprint goals and product milestones.

- Provide guidance and mentorship to junior technical writers or contributors when required.

Required Skills & Technical Expertise :

- Proven experience (24 years) in technical writing or information development within a product or platform environment.

- Strong technical understanding of RESTful APIs, JSON, multi-threaded applications, and web-based architectures.

- Proficiency with HTML, Markdown, and documentation authoring tools such as MadCap Flare, Jekyll, or Sphinx.

- Familiarity with source control systems (Git/GitHub) and continuous integration pipelines for documentation publishing.

- Strong grasp of information types, including concepts, procedures, reference materials, and troubleshooting content.

- Experience using API documentation generators, knowledge base systems, and content management workflows.

- Excellent communication, analytical thinking, and interviewing skills to extract and interpret technical information from SMEs.

- Ability to multitask, work independently, and manage multiple documentation projects simultaneously in an agile environment.

Education & Experience :

- Bachelors or Masters degree in Computer Science, Engineering, Information Technology, Technical Communication, or a related field.

- 2 to 3 years of experience in product, platform, or SDK documentation within a technology-driven organization.

Preferred Qualifications :

- Experience with DevOps documentation workflows and publishing automation.

- Exposure to data management, cloud platforms, or enterprise SaaS ecosystems.

- Familiarity with Markdown-based static site generators and API schema modeling.

Key Responsibilities :

Technical Documentation Development :

- Design, develop, and maintain technical documentation for Syndigos platforms, SDKs, APIs, and enterprise applications.

- Produce and manage content across multiple formats including HTML, Markdown, and XML using modern documentation frameworks such as MadCap Flare, Jekyll, or equivalent open-source tools.

- Create comprehensive REST/JSON API documentation using tools such as Swagger, Postman, or OpenAPI specifications.

- Validate documentation accuracy by setting up, configuring, and testing products in real runtime environments.

Information Architecture & Content Strategy :

- Define and implement information architecture standards to ensure scalability, consistency, and reusability of content across multiple documentation sets.

- Establish and maintain content templates, authoring guidelines, and documentation workflows for consistent style and technical accuracy.

- Collaborate with engineering and product management to ensure that documentation aligns with software releases, feature updates, and UX designs.

Quality & Review Processes :

- Perform self-checks, peer reviews, and technical validations to ensure clarity, accuracy, and adherence to documentation standards.

- Participate in usability testing of information deliverables and incorporate user feedback to continuously improve content quality.

- Contribute to improving UI/UX text elements such as GUI labels, tooltips, and error messages for better user experience.

Cross-functional Collaboration :

- Partner with developers, QA engineers, and product owners to gain deep understanding of system functionality, workflows, and dependencies.

- Actively engage in agile development processes to ensure documentation deliverables are synchronized with sprint goals and product milestones.

- Provide guidance and mentorship to junior technical writers or contributors when required.

Required Skills & Technical Expertise :

- Proven experience (2 ot 4 years) in technical writing or information development within a product or platform environment.

- Strong technical understanding of RESTful APIs, JSON, multi-threaded applications, and web-based architectures.

- Proficiency with HTML, Markdown, and documentation authoring tools such as MadCap Flare, Jekyll, or Sphinx.

- Familiarity with source control systems (Git/GitHub) and continuous integration pipelines for documentation publishing.

- Strong grasp of information types, including concepts, procedures, reference materials, and troubleshooting content.

- Experience using API documentation generators, knowledge base systems, and content management workflows.

- Excellent communication, analytical thinking, and interviewing skills to extract and interpret technical information from SMEs.

- Ability to multitask, work independently, and manage multiple documentation projects simultaneously in an agile environment.

Education & Experience :

- Bachelors or Masters degree in Computer Science, Engineering, Information Technology, Technical Communication, or a related field.

- 2 to 3 years of experience in product, platform, or SDK documentation within a technology-driven organization.

Preferred Qualifications :

- Experience with DevOps documentation workflows and publishing automation.

- Exposure to data management, cloud platforms, or enterprise SaaS ecosystems.

- Familiarity with Markdown-based static site generators and API schema modeling.

- Working knowledge of version control, scripting, or automation tools (e.g., Python, YAML, or GitHub Actions).

- Working knowledge of version control, scripting, or automation tools (e.g., Python, YAML, or GitHub Actions).