Overview
Job Summary:
As a Technical Writer at ReBid, you will be responsible for creating clear and concise
documentation for our platform. You will work closely with our development team to
understand the technical aspects of our product and translate them into easy-to-understand
documentation. Your work will also help our clients to use our platform effectively and
efficiently.
Roles & Responsibilities:
● Collaborate with our development team to understand the technical aspects of our
product.
● Create and maintain comprehensive documentation for our platform as mentioned in
the documentation section
● Develop and maintain documentation templates, versions, and style guides.
● Ensure that all documentation is accurate, up-to-date, and easy to understand.
● Manage and prioritize documentation tasks, working under tight deadlines.
● Review and edit documentation created by other team members for consistency and
accuracy.
● Work closely with our customer success team to understand client needs and provide
documentation solutions.
● The final deliverables should be in a format that is easy to read and navigate and
should be delivered within the agreed-upon timeframe
Required documentation:
API documentation: This document should provide a detailed description of each API
endpoint, including input and output parameters, expected response codes, and any
potential errors or exceptions. The documentation should also include examples of how to
use each endpoint.
Database schema documentation: This document should provide a detailed
description of the database schema, including tables, columns, relationships, and data
types. The documentation should also include any business rules or constraints that apply to
the data.
Reporting structure documentation: This document should provide a detailed
description of the reporting structure for the application, including the types of reports
available, the data sources used for each report, and any customizations that can be made
to the reports.
Jobs infrastructure: The technical writer should create documentation for the job
infrastructure used in our product. This should include information on the types of jobs
executed, the scheduling, and any dependencies or prerequisites.
Code architecture: The technical writer should create documentation for the code
architecture used in our product. This should include information on the overall design, key
components, and any design patterns or principles used.
Workflows: The technical writer should create documentation for the workflows used in
our product. This should include information on the various processes, the steps involved,
and any dependencies or prerequisites.
User-facing documentation: The candidate should be able to create user-facing
documents like a Help center covering a step-by-step guide for the initial setup of our
products, each feature workflow, Module wise FAQs, SOPs, and features documentation
explaining how to use a specific feature on the product.
Marketing collaterals: The candidate should be able to produce marketing collaterals like
technical blogs, whitepapers, and newsletters for our website and other stakeholders
Skills & Experience:
1. Bachelor's degree in Technical Writing, Computer Science, or a related field.
2. 2+ years of experience in technical writing, preferably in the software development
industry.
3. Excellent written and verbal communication skills.
4. Strong technical aptitude and the ability to understand complex technical concepts.
5. Proficiency in documentation tools such as Confluence, Jira, and GitHub.
6. Knowledge of HTML, CSS, and Markdown.
7. Experience working in an Agile development environment.
8. Ability to work independently and manage multiple projects simultaneously.
9. Familiarity with advertising technology and digital marketing is a plus.
We offer a competitive salary, a comprehensive benefits package, a dynamic work
environment, and hybrid work culture. If you are passionate about technology and have a
talent for writing clear and effective documentation, we would love to hear from you. Please
submit your resume, cover letter, and portfolio of your previous technical writing work.
About RD&X Network
Founded by entrepreneur Rajiv Dingra, ReBid is a technology company offering
transformational martech, adtech, and deep tech products and solutions to drive creative,
media, data, and business transformation, helping global businesses become real-time,
disruptive, and thereby achieve exponential growth. We have some of the best industry
talents on board and we identify ourselves as Transformists. We believe that transformation
is not just for business, but for our people too. ReBid is a Madtech unification platform that
helps advertisers to streamline their ad tech stack and unify data sources. Our platform is
designed to simplify the complexity of the advertising industry by providing a single source of
truth for ad data, insights, and analytics. We are currently seeking a Technical Writer to help
us create comprehensive documentation for our product.
To know about the products that we are building, you can take a quick glance at our website:
https://www.rebid.co/