Technical Writer

Apache Associates; Stevenage; Hybrid; GBP 30,000 - 45,000; Full time

Job summary

A leading company in technology solutions is seeking a Technical Writer for a 6-month contract role to enhance their Developer Platform. The successful applicant will lead the effort to improve documentation while collaborating with technical experts. This hybrid position requires a strong technical writing background and an understanding of UX principles, particularly for developer-focused content. Candidates with experience in documentation frameworks and tools will be highly regarded.

Qualifications

• Strong background in technical writing with a portfolio.
• Experience in restructuring complex documentation sets.
• Excellent communication skills in English.

Responsibilities

• Conduct a documentation audit and propose new architecture.
• Identify improvements for product design and UX.
• Liaise with domain experts to ensure accuracy.

Skills

Technical writing

Information architecture

User experience (UX) best practices

Markdown

reStructuredText

Git

Docker

Kubernetes

Documentation methodologies

Agile/Scrum experience

Tools

Sphinx

ReadTheDocs

Jira

Confluence

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 withMarkdown,reStructuredText, andGit
• Ability to absorb and simplify complex technical information
• Excellent communication skills in English
• Experience contributing to or maintaining open-source projects
• Understanding ofDocker,Kubernetes, and modern cloud environments
• Experience documenting APIs and large-scale systems
• Hands-on knowledge of tools likeSphinx,ReadTheDocs,Jira, andConfluence
• Knowledge of documentation methodologies like theDiátaxis framework
• Agile/Scrum team experience

This position is a 6 month contract role.

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.

Apply

Upload Your CV

Please check to confirm you are happy for us to process your data in accordance with our terms and privacy policy .