Technical Writer

ZipRecruiter; Stevenage; Hybrid; GBP 80,000 - 100,000; Full time

Job summary

A leading job platform is seeking a Technical Writer for a 6-month contract in Stevenage. The role focuses on auditing and enhancing the Developer Platform documentation, improving user experience, and collaborating with technical experts. Candidates should have a strong background in technical writing, proficiency in Markdown, and experience with information architecture. Daily rates range from £400 to £450, with a hybrid work model requiring 3 days onsite.

Qualifications

• Strong background in technical writing with a portfolio of developer-focused content.
• Ability to absorb and simplify complex technical information.
• Experience overhauling and restructuring complex documentation sets.

Responsibilities

• Conduct a review of existing documentation and propose new architecture.
• Identify improvements to create a better UX for developers.
• Liaise with software developers to ensure documentation accuracy.

Skills

Technical writing

Documentation structure overhaul

Information architecture

Markdown

reStructuredText

Git

Excellent communication skills in English

Tools

Sphinx

ReadTheDocs

GitLab CI/CD

Jira

Confluence

Job description

Job Description

Role Summary We are seeking a Technical Writer for a 6-month contract to take the lead in evolving and enhancing an existing Developer Platform.

Your primary goals will include:

• Reviewing the current documentation
• Proposing and implementing a more intuitive structure • Identifying and correcting inconsistencies in layout and content, and suggesting strategies for harmonisation
• Enhancing the user experience (UX) and improving consistency across products
• Evaluating the current infrastructure and proposing improvements, such as implementing a unified documentation framework based on industry best practices.

You will work closely with domain experts to ensure the technical accuracy of the content. The role requires enough technical knowledge to understand the documentation and work independently.

Key Responsibilities

• Documentation Audit and Restructuring: Conduct a review of existing documentation on the Developer Platform. Propose and implement new architecture that is more intuitive, user-friendly, and scalable.
• UX Enhancements: Identify and suggest improvements to the product design and navigation to create a better UX for developers.
• Collaboration: Liaise with software developers and other SMEs to ensure the documentation is technically accurate & up-to-date.
• Tooling and Automation: Work within a documentation-as-code environment, using tools such as Sphinx, ReadTheDocs, and GitLab CI/CD to manage and publish documentation.

Essential Skills and Experience

• Strong background in technical writing with a portfolio of developer-focused content
• Experience overhauling and restructuring complex documentation sets
• Solid grasp of information architecture and UX best practices for documentation
• Proficiency with Markdown, reStructuredText, and Git
• Ability to absorb and simplify complex technical information
• Excellent communication skills in English

Desirable Skills & Experience

• Experience contributing to or maintaining open-source projects
• Familiarity with Python, JavaScript, C++, or frameworks like React and FastAPI
• Understanding of Docker, Kubernetes, and modern cloud environments
• Experience documenting APIs and large-scale systems
• Hands-on knowledge of tools like Sphinx, ReadTheDocs, Jira, and Confluence
• Knowledge of documentation methodologies like the Diátaxis framework
• Agile/Scrum team experience

This position is a 6 month contract role. Daily rate is £400 - £450

Hyrbid role - will require 3 days onsite in Stevenage.

Due to the volume of applications, we can only reply to those that match these requirements.