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.

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

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.

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

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

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.

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.