22 Sep
|
Intech Creative Services
|
Hyderabad
22 Sep
Intech Creative Services
Hyderabad
Technical Writer
AI-Augmented Documentation • Terminal Operating Systems (TOS)
Role Overview
We are seeking a Technical Writer who bridges the gap between maritime port logistics, enterprise documentation systems, and interactive learning. In this AI-augmented role, you will use AI tools to generate first-draft documentation from PRDs, Jira stories, source code, and product changes, then apply expert judgment to verify, correct, and finalize it into publication-ready manuals. You will manage documentation updates directly through engineering ticketing workflowsusing MadCap Flare and Gitbook to single-source Terminal Operating System (TOS) guides, validating API behaviors through hands-on workplace testing, and translating operational logic into clear user documentation and interactive eLearning modules.
Key Responsibilities
- Use AI to generate first-draft technical documentation and track, prioritize, and complete documentation tickets in JIRA/issue trackers alongside engineering sprints to support continuous API and software releases, keeping pace with release velocity through faster draft turnaround.
- Generate training materials for end-users to familiarize themselves with TOS end-to-end flows, verifying the content against the system and documentation and refining the AI output for accuracy, tone, and completeness.
- Conduct hands-on testing and validation in QA/staging environments to verify API behavior, endpoints, and TOS workflows before documenting them, and to fact-check AI-generated drafts against actual system behavior.
- Single-source, draft with AI, refine, and maintain technical documentation for our Terminal Operating System (TOS) platform using MadCap Flare and Gitbook.
- Use AI to draft API references, configuration guides, and system architecture guides from source code,
specifications, and PRDs, then edit to final publication quality within Flare and developer portals.
- Design and AI-draft interactive micro-learning courses, simulation scripts, and video walk-throughs for port operators, terminal managers, and system integrators, applying the final instructional-design and quality polish.
- Collaborate with domain experts—maritime engineers, vessel planners, and TOS developers—to translate complex logistics workflows into accessible technical content.
- Engineer effective prompts and build reusable prompt templates so AI produces accurate, on-brand, terminology-consistent first drafts of TOS documentation.
- Critically review AI-generated content to catch hallucinations, factual errors, and gaps—owning final accuracy, style, and sign-off before publication.
- Continuously improve the AI documentation workflow, feeding product changes, glossary updates, and style rules back into prompts and templates to raise draft quality over time.
Required Qualifications
- Domain experience in Maritime Logistics or Port Operations: Direct familiarity with Terminal Operating Systems (e.g., Navis N4, COSMOS, Tideworks, or proprietary TOS), container terminal workflows (quay crane scheduling, yard planning, gate automation, vessel stowage), or maritime EDI standards (EDIFACT BAPLIE, COARRI, CODECO).
- Proficiency with AI writing tools:
Hands-on experience using LLM-based assistants (e.g., Claude, ChatGPT, GitHub Copilot, or documentation-specific AI) to generate and iterate on drafts, combined with the editorial judgment to verify, correct, and finalise AI output.
- Prompt engineering & AI-output review: Ability to craft precise, context-rich prompts and to critically evaluate generated content for factual accuracy, completeness, and terminology consistency.
- Hands-on API & Environment Testing Experience: Ability to navigate developer staging environments, perform functional testing, and follow JIRA/issue-tracking tickets through the software development lifecycle (SDLC), using that testing to validate AI-drafted content.
- Proficiency with MadCap Flare: Hands-on experience in single-sourcing, topic-based authoring, condition tags, target management, and multi-channel publishing (HTML5/PDF).
- Technical Writing experience for developer software: Experience documenting APIs or system integration points, including editing and fact-checking drafts to publication quality.
- Proficiency with eLearning and Authoring Tools: Experience building interactive courses using tools such as Articulate Storyline, Rise 360, Camtasia, or Adobe Captivate.
Preferred / Bonus Qualifications
- Prior experience working on-site at a container, bulk, or intermodal terminal.
- Familiarity with SCORM/xAPI standards and LMS integration.
- Experience with Git version control for integrating Markdown streams into MadCap Flare.
- Basic understanding of code samples in Python, Java, or C# for API integration guides.
- Experience defining AI documentation standards—prompt libraries, style guides, or terminology glossaries that keep generated content accurate and consistent.
📌 Senior Technical Writer (Hyderabad)
🏢 Intech Creative Services
📍 Hyderabad