05 Nov
|
Aditi Consulting
|
Chennai
05 Nov
Aditi Consulting
Chennai
Summary We are seeking a technical writer to create explicit, practical documentation for users adopting and operating an enterprise integration service. The writer will collaborate with product owners, implementation teams, support personnel, subject-matter experts, and engineers to translate complex processes into accessible guidance. Documentation is managed through a docs-as-code workflow, and the writer will use AI-assisted tools responsibly to improve research, drafting, consistency, and maintenance. Job
Responsibilities:
• Create onboarding, configuration, operational, troubleshooting, and support documentation.
• Explain integration workflows, expected system behavior, data requirements, and error handling in accessible language.
• Produce task-based guides, quick-reference materials, FAQs, release notes, and escalation procedures.
• Interview subject-matter experts and validate instructions from the reader’s perspective.
• Manage documentation as version-controlled content using Markdown, Git, branches, pull requests, and peer reviews.
• Coordinate documentation changes with product releases and operational changes.
• Use AI tools to support research, drafting, editing, summarization, terminology management, and content-gap analysis.
• Verify all AI-assisted content against authoritative sources and subject-matter experts.
• Protect confidential information and follow organizational requirements governing approved AI tools and data handling.
• Establish consistent terminology, reusable templates, ownership, approval workflows, and review schedules.
• Use documentation analytics, feedback, and support trends to prioritize improvements. Required
Skills:
• Experience writing technical or operational documentation for external customers or enterprise users.
• Strong ability to explain complex systems without unnecessary technical detail.
• Experience producing onboarding guides, configuration instructions, troubleshooting articles, FAQs, and support procedures.
• Practical experience with docs-as-code workflows, including Markdown, Git, pull requests, and review processes.
• Experience using generative AI or other AI-assisted authoring tools productively and responsibly.
• Ability to validate AI-generated material rather than treating generated output as authoritative.
• Understanding of integrations, dependencies, data flows, configuration, and technical terminology.
• Excellent interviewing, research, editing, and information-architecture skills.
• Strong written English and experience collaborating across cultures and time zones. Education &
Qualifications:
• Experience documenting enterprise integrations, SaaS platforms, APIs, or data-exchange systems is preferred.
• Familiarity with static-site documentation platforms and automated documentation checks is a plus.
• Experience creating diagrams, workflow illustrations, screenshots, and visual guidance is advantageous.
• Familiarity with dealership, ERP, parts, service, equipment, rental, or customer-data processes is beneficial.
• Experience working with implementation, customer-success, training, or production-support teams is desirable.
• Experience developing AI prompts, reusable authoring workflows, terminology controls, or AI-assisted content-quality checks is preferred.
• A practical candidate exercise should require submission through a small Git repository. Ask the candidate to improve a flawed onboarding or troubleshooting document, describe how AI was used, identify what required human verification, and submit the change through a pull request. This tests customer empathy, writing judgment, docs-as-code capability, and responsible AI usage together #AditiConsulting #26-06455
📌 Digital Content Specialist (Chennai)
🏢 Aditi Consulting
📍 Chennai