Description

You will document Python APIs and web-based user interfaces for technical and non-technical users.

Responsibilities

• Develop and maintain technical documentation, including user manuals, API references, integration guides, and tutorials.
• Collaborate with developers and product managers to capture API details and supported use cases.
• Create accurate Python code samples, snippets, and inline comments to demonstrate functionality.
• Translate complex code logic into clear documentation through participation in code review sessions.
• Update documentation to reflect software enhancements, new feature releases, and API changes.

Required Skills

• Proven experience as a technical writer specifically documenting Python APIs.
• Strong understanding of Python, including data structures and common libraries.
• Ability to write clean, accurate code samples in Python.
• Familiarity with API architecture and formats such as REST, JSON, SOAP, or GraphQL.
• Experience with API documentation tools like Swagger, Postman, Sphinx, or MkDocs.
• Experience using version control systems such as Git.
• Experience working within an agile environment.
• Strong technical writing skills with an emphasis on clarity and detail.

Preferred Skills

• Experience with automated documentation tools like Sphinx or pydoc.
• Familiarity with cloud services, CI/CD pipelines, and DevOps tools.
• Previous technical writing experience for developer tools or open-source projects.

Key Skills

Education

Not specified