Technical Writer

Job Description

Job Description

This role requires 3 days a week onsite

We are seeking a skilled and detail-oriented Technical Writer with experience in documenting Python APIs and web-based user interfaces.

The ideal candidate will work closely with our development team to create clear, comprehensive, and user-friendly documentation.

You will be responsible for transforming complex technical concepts into easy-to-understand guides, tutorials, reference material, and API documentation for both technical and non-technical users.

Responsibilities :

Develop and maintain high-quality technical documentation for Python APIs and a web-based GUI, including user manuals, API references, integration guides, and tutorials.

Collaborate with developers, product managers, and other stakeholders to gather detailed knowledge of the APIs and the use cases they support.

Write, edit, and update technical content that is clear, concise, and accessible for varying audiences, from developers to non-technical stakeholders.

Ensure documentation is well-organized and follows best practices in API documentation.

Create code samples, inline comments, and snippets to demonstrate API functionality and usage in Python.

Participate in code review sessions, understand code logic, and translate it into easily understandable language.

Keep API documentation up-to-date with software updates, enhancements, and new feature releases.

Assist in the creation of quick-start guides, FAQs, and troubleshooting sections for developers using the API.

Ensure consistency in terminology, formatting, and branding across all technical documentation.

Required Skills :

Proven experience as a technical writer, specifically documenting Python APIs.

Strong understanding of the Python programming language, data structures, and common Python libraries.

Familiarity with API architecture and formats like REST, JSON, SOAP, or GraphQL.

Experience with API documentation tools and platforms (e.g., Swagger, Postman, Sphinx, MkDocs).

Ability to write clean, concise, and accurate code samples in Python.

Excellent writing and communication skills, with strong attention to detail.

Familiarity with version control systems (e.g., Git) and experience working in an agile environment.

Ability to work collaboratively with cross-functional teams.

Desired Skills :

Experience with automated documentation tools (e.g., Sphinx, pydoc).

Familiarity with cloud services, CI / CD pipelines, and other DevOps tools.

Previous experience in technical writing for developer tools or open-source projects.

Powered by JazzHR

l2jtmc2kK2