Technical Writer
- Solverminds Solutions
- 2 - 4 years
- Chennai
- 11 days ago
- Email to a friend
- Report this job
Job Description
Project Location(s): Siruseri,Chennai
No. of Positions: 1
Responsibilities:
- Component Documentation:
Analyze each system component (services, databases, APIs, UIs) and document its purpose, interfaces, inputs/outputs, and deployment considerations.
Create clear architecture diagrams, data flow charts, and component interaction maps to illustrate system structure. - Integration Guides:
Describe how components integrate with each other, including communication protocols (REST, gRPC, messaging), authentication/authorization flows, and deployment pipelines.
Detail integration with third-party services (e.g., payment gateways, CRMs) and internal systems (e.g., identity provider, event bus). - Developer-Level Technical Detail:
Write in-depth developer guides covering API specifications (endpoints, request/response schemas, error codes), SDK usage examples, and code snippets in relevant languages.
Document configuration parameters, environment variables, and command-line tools needed for local development, testing, and production deployment. - Testing Plans & Strategies:
Develop testing plans that cover unit, integration, and end-to-end testing scenarios for each component and service.
Describe test data setup, mock service usage, performance/load testing approaches, and automated test frameworks (e.g., JUnit, pytest, Postman). - Microservices Expertise:
Explain microservices design principles in your documentation service boundaries, fault isolation, scalability patterns, and data consistency strategies (e.g., sagas, eventual consistency).
Provide guidance on best practices for service registration/discovery, circuit breakers, and observability (metrics, logging, tracing). - Quality & Consistency:
Ensure all documentation adheres to established style guidelines, is version-controlled, and is continuously reviewed and updated.
Collaborate in an agile environment participate in sprint planning, backlog grooming, and review documentation as features evolve. - Aware of standard documentation procedures.
- Deveop SoPs for developing standardized process of operation.
Technical Skills:
- 2-4 years of professional experience in technical writing , user story creation , or a similar role within the IT industry.
- Proven ability to write clear and concise technical documents and user-focused content .
- Strong experience with JIRA , Confluence , or similar tools.
- Basic understanding of software development processes (Agile/Scrum preferred).
- Excellent written and verbal communication skills.
- Strong attention to detail and ability to deliver high-quality documentation on time.
Personal Skills:
- Experience working in Agile environments or on software development projects.
- Familiarity with creating documentation for APIs, software products, or IT services.
- Exposure to UX writing or user journey documentation.
COVID-19: The health & safety of our team, candidates, and our community are very important to us. Please note, only those applicants with relevant industry experience will be contacted with their application.
Job Posting Title Location Department Date Technical Writer Siruseri,Chennai July 4, 2025 Full stack Developer(Java, Angular) Siruseri, Chennai May 5, 2025 Lead Engineer Siruseri, Chennai May 5, 2025 Spring Boot Developer Siruseri, Chennai May 5, 2025 Business Development Associate (Entry-Level) Atlanta, Georgia, United States April 23, 2025
Ready for a career journey with Solverminds?
Connect with our recruitment team:
For background verification, please reach us out:
Apply for a career online:
career portal
career portal
Solverminds is a leading global technology company providing enterprise resource management solutions, consulting and data analytics services to the maritime industry.
Job Classification
Industry: IT Services & ConsultingFunctional Area / Department: Content, Editorial & JournalismRole Category: Content Management (Print / Online / Electronic)Role: Technical Content DeveloperEmployement Type: Full timeContact Details:
Company: Solverminds SolutionsLocation(s): Chennai+ View Contact
Keyskills: IT services Communication protocols Load testing Technical writing Consulting Agile SDK JIRA Resource management Recruitment
Fraud Alert to job seekers!
₹ Not Disclosed
Similar positions
Solverminds Solutions
T & A Info Solutions is an offshore software outsourcing company from India offering software development services to Worldwide. We have specialised in providing Offshore development services exclusively for Shipping / Marine industry. Our offshore software outsourcing services and solutions are des...
Job Listings
We are in open beta version of website, please let us know if any issues, at: info(at)indigojobs.in