Software Documentation Developer at Documentat.io
We are searching for an experienced software engineer who understands the value of good documentation and is willing to commit 100% of his/her working hours to the creation of developer-targeted documentation.
If you enjoy documenting your APIs, love writing insightful code comments and take pride in creating clean and complete READMEs for your GitHub projects, this is the job for you!
We want to grow an excellent technical writer from an experienced software engineer – mainly because only a person with experience in software development fully understands the requirements for great developer-targeted documentation.
This position may interest a broad range of engineering specialists other than developers: DevOps experts, QA automation engineers, SREs, system administrators...
About us
We are a small consulting and outsourcing company specializing exclusively in creating technical documentation. We help other software companies create and maintain user manuals, API/SDK references, knowledge bases, and multi-purpose documentation portals.
Your responsibilities
You will create the following kinds of documentation:
• API references (mostly for RESTful HTTP APIs)
• SDK docs (mostly for iOS and Android libraries)
• Software architecture descriptions (using industry-grade approaches like IEEE SAD or ADR)
• User manuals for desktop applications and web-based solutions
• Deployment/installation instructions for Linux-based server applications
Apart from that you will be responsible for creating and maintaining technical infrastructure for documentation: publishing pipelines (cf. GitBook or Sphinx-doc), documentation linters, etc.
This is the perfect job for you if:
• you love writing, explaining things and structuring information
• you stopped enjoying your current career track (writing code is not fun anymore?) and you are looking for other opportunities inside our industry
• you want to apply your broad technical expertise in the most effective way possible (you can easily employ your knowledge of 3 different programming languages within a single documentation project)
• you want to conceive and develop new industrial standards for documenting APIs and describing software architecture
• you reached a salary plateau on your current career track and do not see any further advancement perspectives
Mandatory requirements for candidates:
• 3+ years of working experience in commercial software development
• experience with at least two of the following languages: PHP, JavaScript, Java, Objective-C
• excellent written Russian: no spelling mistakes, capability to convey textual information in a structured and understandable manner
Would be nice to have:
• excellent written English (preferably C1 / Advanced)
• hands-on experience with Linux-based systems: you should be fine with writing a simple shell script, parsing logs using command-line tools, etc.
• experience with industry-grade tools for API documentation (Swagger, Postman...)
• familiarity with modern documentation tooling: lightweight markup languages (AsciiDoc, Markdown, rST) and their limitations, generators and converters for documentation (Pandoc, Sphinx-doc), documentation linters...
If you have any examples of developer-targeted documentation created by you, don't hesitate to attach it to your cover letter.
Our benefits:
• small and friendly team, no unnecessary management chains
• healthy vibe of a young startup: easy salary negotiations and fast career advancement
• flexible working schedule (part-time is fine), remote is also fine
Each candidate will be given a test assignment.
Your salary will be determined by your writing skills, technical expertise, level of English, and results of the test assignment.
@factorized