Revised description:
Our client is looking for a Technical Author to help them create a developer portal that will support the organisations that use their APIs and SDKs.
You will help them develop the documentation:
- API reference documentation
- Ideally, the SDK documentation
- The SDKs are used by their partners to build mobile apps written in Java, Kotlin and Swift
- Other developer guides
- Guides on implementing complete features with the APIs
- Write or edit code samples for the guides
- Assist developers who will be contributing content
You must have experience in:
- Writing documentation for APIs
- Ideally, experience of documenting SDKs
- Writing developer guides
- Working with OpenAPI specification files
You must be able to work with:
- Javadoc, markdown (Swift-flavoured)
- Tools that generate reference documentation from the source code (such as Kotlin and Swift)
- git or GitHub
The work will involve looking at code (Kotlin, Java, Swift, Ruby, Javascript etc.), and making calls to APIs.
They are looking for a contractor to start in August. Rate: £320-£375/day. The documentation is written in a mixture of HTML and Markdown. They would would prefer the person to work on-site, as they need to collaborate and extract knowledge from other teams.
Leave a Reply