Job Description
Title: Technical Writer
Company Name: Computer Network Systems (CNS) Ltd.
Vacancy: 03
Age: At least 22 years
Job Location: Dhaka
Salary: Negotiable
Experience:
- At least 3 years
- The applicants should have experience in the following business area(s): IT Enabled Service
Published: 2024-11-17
Application Deadline: 2024-11-30
Education: - Bachelor's degree in Technical Communication, English, Computer Science, Information Technology, or a related field.
- Relevant certifications in technical writing (e.g., Society for Technical Communication) are a plus.
Requirements: - At least 3 years
- The applicants should have experience in the following business area(s): IT Enabled Service
Skills Required: DevOps,JavaScript,Postman,Research and Development,Swagger
Additional Requirements: Experience:
- Proven experience (3+ years) as a Technical Writer in an IT or software development environment.
- Experience documenting software, APIs, cloud solutions, or complex IT systems.
- Familiarity with Agile development methodologies is preferred.
Technical Skills:
- Strong understanding of software development concepts, IT terminology, and programming languages.
- Proficiency with documentation tools such as Microsoft Word, Google Docs, Adobe Acrobat, and Markdown.
- Experience with version control systems (e.g., GitHub, GitLab) for managing documentation.
- Knowledge of HTML, CSS, and basic web design principles is an advantage.
Communication and Writing Skills:
- Exceptional writing, editing, and proofreading skills with attention to detail.
- Ability to convey complex technical information in a clear, concise, and engaging manner.
- Strong organizational skills and ability to handle multiple projects simultaneously.
Preferred Qualifications:
- Familiarity with tools like Atlassian Confluence, SharePoint, Notion, or MadCap Flare.
- Experience in creating API documentation using tools like Swagger, Postman, or JSDoc.
- Knowledge of cloud platforms (e.g., AWS, Azure, Google Cloud) or DevOps practices.
- Basic understanding of programming languages like Python, JavaScript, or Java for creating relevant examples.
Soft Skills:
- Excellent research and information-gathering skills.
- Strong interpersonal skills to collaborate effectively with cross-functional teams.
- Ability to learn quickly and adapt to new technologies.
- Self-motivated with a proactive attitude towards problem-solving and knowledge sharing.
Responsibilities & Context: Documentation Creation:
- Develop, write, and maintain comprehensive technical documentation, including user manuals, installation guides, API documentation, system architecture documents, and troubleshooting guides.
- Produce content for developer resources, such as code examples, best practices, and detailed technical specifications.
- Create release notes, changelogs, and updates for new software versions.
Collaboration and Information Gathering:
- Collaborate with engineers, developers, product managers, and subject matter experts to gather and understand technical information.
- Participate in software development meetings, demos, and training sessions to stay updated on new features and product changes.
- Conduct interviews with team members to clarify complex concepts and procedures.
Content Management:
- Maintain and organize documentation in a centralized knowledge base, ensuring easy accessibility for internal and external stakeholders.
- Continuously update and improve existing documentation to reflect changes in software functionality or technology.
- Develop and manage documentation templates, style guides, and standards to ensure consistency.
User-Focused Content:
- Write end-user documentation, FAQs, and how-to guides that translate technical jargon into simple, user-friendly language.
- Create visual aids (such as diagrams, screenshots, flowcharts, and videos) to enhance written content and explain technical concepts clearly.
- Optimize content for various formats, including web, PDF, and print.
Quality Assurance:
- Edit and proofread documentation for clarity, accuracy, grammar, and consistency.
- Conduct usability tests on documentation with internal users or customers to ensure it meets their needs.
- Gather feedback from users and stakeholders to identify gaps in documentation and implement improvements.
Tool and Process Management:
- Use content management systems (CMS) and version control systems to track and manage changes to documentation.
- Develop and use knowledge management tools, such as Confluence, SharePoint, or Notion, to maintain a centralized knowledge repository.
- Utilize tools like Swagger, JSDoc, or Docusaurus for creating API documentation.
Job Other Benifits: Employment Status: Full Time
Job Work Place: Work at office
Company Information: Gender: Male and Female can apply
Read Before Apply: Please apply only who are fulfilling all the requirements of this job
Category: IT & Telecommunication