Job Description

Technical Document Writer Contract / Permanent: Contract with possibility to convert Perm. Kuala Lumpur, Malaysia (Onsite) Job Summary: As a Technical Document Writer, your primary focus will be to create clear, concise, and comprehensive technical documentation to support various products, services, or processes within the organization. The role requires collaboration with subject matter experts, technical heads, other internal and external stakeholders to gather information and ensure accuracy in the documentation. It\'s important that the role of a technical writer for source code involves creating documentation that explains the functionality, architecture, and usage of software code. This documentation is crucial for developers, testers, and other stakeholders to understand and work effectively with the codebase. Here is a general job scope for a technical writer focusing on source code documentation: Understand the Codebase: Gain a deep understanding of the software application and the specific code components that need documentation. Collaborate with developers, architects, and product managers to gather information about the purpose, design, and functionality of the code. Create Comprehensive Documentation: Write clear and concise documentation that covers the purpose, usage, and design decisions of the code. Document code structures, algorithms, data structures, and any relevant design patterns. Provide code examples and usage scenarios to illustrate how the code should be implemented and used. Version Control Integration: Ensure that documentation is versioned and synchronized with the codebase, reflecting any changes or updates to the code. Use version control systems (e.g., Git) to track changes and updates in both the code and documentation. API Documentation: If applicable, document APIs (Application Programming Interfaces) comprehensively, including endpoints, parameters, return values, and error handling. Provide sample requests and responses for API endpoints. Collaborate with Development Teams: Work closely with software developers to clarify ambiguities and gather additional information as needed. Attend code reviews and discussions to stay informed about code changes and updates. Maintain Consistency and Standards: Follow documentation style guides and coding standards to maintain consistency across the documentation. Ensure that terminology is accurate and aligns with industry standards. User Guides and Tutorials: Create user-friendly guides and tutorials for developers who are new to the codebase. Include step-by-step instructions and examples to help users understand and implement the code effectively. Review and Update: Regularly review and update documentation to reflect changes in the codebase. Work with development teams to ensure that documentation is always accurate and up-todate. Accessibility and Readability: Write documentation that is accessible to a diverse audience, including developers with varying levels of expertise. Use clear language, organize content logically, and provide sufficient context for understanding. Tools and Technologies: Familiarize yourself with documentation tools and platforms commonly used in the software development industry. Utilize tools such as Markdown, Sphinx, or Doxygen to format and generate documentation. By fulfilling these responsibilities, a technical writer for source code contributes to the overall success of software development projects by facilitating collaboration, reducing ambiguity, and promoting a better understanding of the codebase among team members. Qualifications and Skills: Bachelor\'s degree in a relevant field (e.g., Technical Writing, English, Computer Science) or equivalent work experience. 1-2 year experience as a technical writer, preferably in a technology-oriented environment. Excellent written and verbal communication skills. Strong attention to detail and ability to organize complex information. Familiarity with documentation tools and technologies (e.g., Markdown, XML, documentation management systems). Knowledge of software development processes and terminology. Preferred: Experience with version control systems (e.g., Git). Familiarity with agile development methodologies. Basic understanding of graphic design principles for incorporating visuals into documentation and vice versa. Other benefits : Medical Insurance, EPF. Interested candidates can DM on [HIDDEN TEXT]

foundit