Technical Writer

• 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.

• 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.

• 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.

Solverminds is a leading global technology company providing enterprise resource management solutions, consulting and data analytics services to a maritime industry where business meets the technology. The vision of the company is to develop a “Truly” integrated Enterprise Application Suite for the liner shipping company. Deeper domain expertise and advanced technology platforms offer a complete range of technology products for liner operations management, ship management, agency management, and advanced analytics.

Solverminds is an Equal Opportunity employer. All qualified applicants will receive consideration for employment without regard to race, color, religion, sex including sexual orientation and gender identity, national origin, disability, protected veteran status, or any other characteristic protected by applicable federal, state, or local law.

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.