27 Sep
|
Sigmasoft Infotech
|
Bengaluru
27 Sep
Sigmasoft Infotech
Bengaluru
Role & responsibilities
Key responsibilities
- Write and maintain User Guides, Installation Guides, Developer Guides, API documentation, and Release Notes.
- Validate documentation against the user interface and product functionality.
- Analyse and redesign documentation for improved usability.
- Create HTML help systems using MadCap Flare or similar tooling.
- Provide guidance and mentorship to other technical authors on best practices, tools, and writing standards.
- Implement content reuse and single-sourcing strategies to ensure documentation scalability.
- Collaborate with engineering and product teams to understand recent functionality and document it accurately.
- Apply industry-standard style guides (Microsoft, Chicago) consistently across all documentation.
- Review, edit, and validate AI-generated documentation outputs including inline docs, changelogs, and API references — for accuracy, completeness, and alignment with IQGeo style standards.
- Collaborate with engineering to define and refine prompt templates used in automated documentation workflows triggered on each merge.
- Apply structured prompt engineering to generate first-draft documentation from specifications, API definitions, and engineering notes, validating outputs against actual product behaviour before publication.
- Use AI-assisted tooling to scan documentation sets for terminology inconsistencies, broken cross-references, and outdated content, prioritising remediation across the documentation suite.
- Develop and maintain AI documentation governance practices covering approved tooling, confidentiality guidelines for content shared with external AI services, and validation steps appropriate to each document type.
- Create visuals to explain concepts and processes.
Essential Qualifications & Experience
You must have all of the following:
- Significant experience building and maintaining product documentation including User Guides, Installation Guides, Developer Guides, and Release Notes.
- Experience creating technical documentation using MadCap Flare or a similar tool.
- Experience validating product documentation against the related product.
- An eye for verbal consistency and an appreciation of tone and style.
- Knowledge of handling documentation as "code" (content reuse and future-proofing techniques).
- Single sourcing to produce different variants of documentation from the same source.
- An understanding of responsive layouts and ability to apply techniques to display content on different types of devices.
- Quality proofreading skills and attention to detail.
- Experience working with agile development teams to understand functionality to be documented.
- Excellent oral and written communication skills.
- Experience using industry-standard style guides like Microsoft or Chicago Manuals of Style.
- Fluent written and spoken English.
Desired Qualifications & Experience
Ideally, you'll have some of the following:
- Experience analysing and redesigning documentation for improved usability.
- Experience producing API documentation.
- Experience producing documentation for mobile applications.
- Experience with Geospatial Information Systems (GIS) or web mapping.
- Experience within the telecommunications and/or utilities industries.
- Experience working in an Agile environment.
- Writing for a global audience.
- Writing for translation and localisation.
- Experience using Git or other distributed version control systems.
- Experience mentoring or guiding other technical authors.
- Experience using AI tools (such as AI writing assistants or LLM-based drafting workflows) within a documentation workflow, with a clear understanding of their limitations and the need for human validation.
- Familiarity with structuring documentation for LLM consumption as well as human readers — including the use of clear headings, explicit context, and structured formats that improve AI retrieval accuracy.
Education
Bachelor's degree from an accredited university in English, Communications, Computer Science, or a related field; or equivalent industry experience.
📌 Senior Technical Author (Bengaluru)
🏢 Sigmasoft Infotech
📍 Bengaluru