The Technical Writer with a Developer Background is responsible for writing more developer-focused documentation: tutorials, example source code, and API reference guides, including descriptions for methods, parameters, return values, etc.
The focus of the role is set more on engineering correctness and less on accurate English writing. The rest of the team can take care of that. The role is remote and can be either full time or part time.
- Head of Technical Documentation.
The Tech Writers at Flare
The Tech Writers sit in between the developers and the rest of the world. Their main task is to translate the technical speech into human language for a range of audiences, both inside and outside the company.
At Flare, interacting with the developers and understanding the technology is done mostly by the Head of Documentation, which then teaches the writing team. The writers, in turn, produce the following types of documents, to be consumed by other employees and external users:
- Theoretical descriptions about how each piece of the technology works, including diagrams and glossaries.
- User manuals teaching users how to use certain applications, including screenshots and step-by-step guides (non-tech-savvy audience).
- How-To guides for infrastructure owners to deploy different types of nodes, including console commands and configuration files (tech-savvy audience).
- Developer tutorials, including example source code, explaining how to solve different use cases (developer audience).
No writer is expected to be able to write all kinds of content. We are building a team of writers that can complement and teach each other.
- Have experience developing in any programming language, to be able to write for developers.
- Good communication skills: Able to explain complex topics and make them understandable to a developer audience.
- Good technical competence: You must know what you are talking about, and it must show in your work. You don’t use empty buzzwords: if you don’t know something, you ask, learn, and don’t start writing until you understand the topic.
- Interest in blockchain technology and related topics like cryptocurrencies, finance, Web3 and decentralization.
- Be able to write in English.
How to be a stand-out candidate
- You have written technical documents for blockchain protocols.
- You have written technical documents for a software company.
- You have open-source experience.
- You know your way around git and GitHub.
- You have worked as a Software Engineer or have completed academic studies into software engineering, ideally within Blockchain.
- You have experience with Solidity, Typescript, and/or Golang.
- You have worked in start-ups or early-stage products moving from MVP to deployment.
- You have experience working with cross-functional teams including designers, researchers, and engineers.
- You have experience with automated documentation pipelines (Markdown, mkdocs, GitHub Actions, Netlify).
- You are autonomous in your work. You understand the end goals and the strategy to reach them.
- You can work in a decentralized environment, where your co workers might be in different time zones.
- Native English language is a bonus.