Technical Writer
Share
Job Location:
Monthly Salary:
Experience Required:
Posted on:
4 hours ago
Vacancies:
1 Vacancy
Job Summary
About the Role
We are seeking a skilled and experienced Technical Writer to join our documentation and product engineering team. The ideal candidate will be responsible for creating clear comprehensive and user-friendly documentation for our security products. You will work closely with engineering product management and customer success teams to translate complex technical concepts into content that is accessible to administrators security analysts and enterprise customers.
Key Responsibilities
1. 1. Product Documentation
Produce clear concise and accurate technical documentation including product manuals configuration guides deployment guides troubleshooting articles FAQs and release notes.
Tailor documentation for different audiences such as administrators end-users developers and integration teams.
2. Technical Content Development
Work with product managers engineers QA support and security teams to identify documentation requirements.
Develop documentation plans and content strategies aligned with product roadmap release cycles and user needs.
3. API & Developer Documentation
Create and maintain high-quality documentation for APIs SDKs CLI tools and integration workflows.
Provide developers with actionable examples use-case guidance and clear explanations to support seamless integrations.
4. Information Architecture & CMS Management
Organize structure and maintain documentation within content management systems (CMS) documentation portals and version control systems (e.g. Git or Jira).
Ensure documentation is easy to navigate scalable and optimised for searchability and user experience.
5. Editing Proofreading & Quality Assurance
Review documentation produced by internal teams to ensure clarity technical accuracy consistency grammar and adherence to style guides and terminology standards.
Establish and maintain documentation standards and templates.
6. UX Writing for In-Product Text
Collaborate with UX/UI designers to write or refine in-product content such as tooltips form labels error messages notifications and onboarding text.
Ensure the user interface language is intuitive consistent and aligns with the products tone and usability goals.
7. Continuous Improvement & Feedback Integration
Gather feedback from internal teams customers and subject matter experts to improve documentation quality coverage and usability.
Continuously refine content based on product updates emerging user needs and technical changes.
8. Cross-Functional Collaboration
Work closely with Engineering QA Product Management DevOps/SecOps and Customer Success to understand new features architecture updates technical workflows and integrations.
Translate complex technical information into user-focused easy-to-understand content.
9. Technical Diagram & Visual Design
Create and maintain technical diagrams including architecture diagrams workflow/sequence diagrams network diagrams and UI walkthrough graphics.
Use tools such as Visio Figma Lucidchart or similar to enhance clarity and comprehension.
Requirements
1. Professional Experience
3 years of experience in technical writing preferably within cybersecurity enterprise IT or B2B SaaS.
Experience producing documentation for complex software platforms security workflows or developer APIs.
Familiarity with cybersecurity concepts such as threat intelligence vulnerability management authentication protocols encryption and network security.
Understanding of security tools enterprise IT environments and cloud security (AWS Azure GCP).
Proficiency with tools such as:
a) Jira Confluence Swagger/OpenAPI Postman
b) Git/GitHub Markdown HTML/CSS
c) Diagram tools (Visio Lucidchart Figma)
Experience with API documentation frameworks and developer-oriented content is highly advantageous
Exceptional written and verbal communication skills.
Strong sense of clarity structure and documentation quality.
High accuracy in grammar formatting and technical correctness.
Ability to ensure consistency across large documentation ecosystems and product versions.
Strong interpersonal skills and ability to work across engineering product QA support and design teams.
Comfortable working in fast-paced agile environments with frequent iterations.
Bachelors degree in Computer Science Communications or a related field.
Equivalent practical experience will also be considered.
Required Skills:
Education: Bachelors degree in Computer Science Information Technology or a related field (or equivalent work experience). Experience: 4 years of hands-on experience with AWS cloud platforms including EC2 S3 VPC RDS Lambda and IAM. Proficient in managing both Windows and Unix/Linux servers in a cloud environment. Strong experience with Active Directory integration in a cloud infrastructure. Solid understanding of cloud networking VPC design and security groups. Knowledge of cloud storage solutions like EBS S3 and Glacier. Experience with cloud-based databases- RDS (MySQL and MS SQL Server). Familiarity with load balancing technologies (Elastic Load Balancer) and Auto Scaling in AWS. Experience with cloud monitoring tools such as AWS CloudWatch CloudTrail or third-party tools. Familiarity with cloud services in Azure (e.g. VMs Azure AD Azure Storage) and GCP Skills: Proficiency in scripting languages (e.g. Python Shell PowerShell). Strong understanding of security principles (IAM encryption access control). Excellent troubleshooting and analytical skills. Ability to work in a fast-paced dynamic environment with minimal supervision. Preferred Qualifications: AWS certifications such as AWS Certified Solutions Architect Associate or Professional AWS Certified SysOps Administrator or AWS Certified DevOps Engineer. Experience with containerization (Docker Kubernetes) and serverless computing.
Company Industry
IT Services and IT Consulting
Key Skills
- Proofreading
- Adobe Acrobat
- Content Management Systems
- Technical Writing
- Visio
- Microsoft Powerpoint
- Sharepoint
- XML
- Confluence
- Wiki Systems
- Word Processing
- Writing Skills
