Technical Writer
Company Overview
Not specified.
Job Summary
The Technical Writer will be responsible for creating and maintaining clear, comprehensive documentation that supports both technical and non-technical users. This role will utilize various documentation strategies to facilitate API documentation, code samples, and user guides, ultimately enhancing user experience and supporting organizational goals.
Responsibilities
- Develop and implement documentation strategies for technical content.
- Create and manage API documentation for REST and SDKs in various programming languages (Python, JavaScript, Java).
- Write code samples and multi-language walkthroughs to assist users in understanding product functionalities.
- Collaborate with cross-functional teams to ensure accurate front-end and back-end integration knowledge is documented.
- Leverage documentation-as-code tools like MarkDown, Sphinx, MkDocs, and Docusaurus for efficient documentation practices.
- Utilize version control and Continuous Integration/Continuous Deployment (CI/CD) practices to manage documentation workflows.
- Track usage and feedback to measure documentation effectiveness and perform quality audits on documentation.
Qualifications
- Proven experience in technical writing and documentation strategy development.
- Proficient in reading and writing Python and JavaScript (knowledge of Java is desirable).
- Familiarity with API documentation and creating code samples.
- Understanding of documentation-as-code tooling (e.g., MarkDown, Sphinx, MkDocs, Docusaurus).
- Experience with version control systems, particularly Git, and CI/CD workflows.
- Strong skills in collaborating effectively within Agile environments.
- Ability to communicate effectively with engineers, developer relations, and no-code users.
- Demonstrated user empathy and advocacy for both technical and non-technical audiences.
- Experience in establishing style guides and standards for documentation.
Preferred Skills
- Experience with low-code/no-code platforms.
- Active engagement in open-source communities and conscientious research of best practices related to technical documentation.
Experience
Not specified.
Environment
Not specified.
Salary
Not specified.
Growth Opportunities
Not specified.
Benefits
Not specified.
