Technical Writer 3

Beyond SOF; Richmond (VA); On-site; USD 85,000 - 120,000; Full time

Job summary

Beyond SOF is seeking a Technical Writer to support a cloud-based software development project. You will produce documentation for technical and non-technical audiences, including user guides, API documents, and release notes within an Agile team.

Applicants should submit a writing sample. The role emphasizes clarity, accuracy, and the ability to distill complex information from SMEs into accessible content.

Qualifications

• 5+ years of experience creating software documentation (user guides, API docs, release notes).
• Ability to tailor content for both technical and non-technical audiences.
• Proficient at organizing complex technical information clearly and logically.
• Expert in MS Word, Google Docs, Confluence or similar tools.
• Knowledge of Markdown, HTML/CSS for web delivery.
• Proficient with Adobe Acrobat, SnagIT or similar tools for visuals.
• Experience with Git or other version control and documentation platforms such as GitBook.
• Understanding of Scrum/Agile methodology.
• Familiarity with REST APIs, JSON, and software architecture concepts.
• Ability to read code snippets and translate to clear docs.
• Excellent grammar, clarity and attention to detail.
• Ability to interview SMEs and distill complex information.
• Strong versioning and documentation review practices.
• Experience writing for software products (SaaS, desktop, or mobile).
• UX writing is highly desirable; familiarity with diagramming tools requested.

Responsibilities

• Produce written product documentation for technical and non-technical audiences for an Agile team.
• Create user guides, API documents and release notes.
• Interview SMEs to distill complex information into clear docs.
• Maintain versioning and documentation reviews for accuracy and consistency.
• Develop visuals and diagrams to support technical content.

Skills

Software documentation

Content tailoring

Organizing complex information

MS Word / Google Docs / Confluence

Markdown / HTML / CSS

Adobe Acrobat / SnagIT

Git / version control / GitBook

Scrum / Agile

REST APIs / JSON

Reading code snippets

Grammar & clarity

Interview SMEs

Versioning & reviews

UX writing

Diagramming tools (Lucidchart/Draw.io)

Tools

GitBook

Git

MS Word

Google Docs

Confluence

Lucidchart

Draw.io

SnagIT

Adobe Acrobat

Job description

The client is seeking a Technical Writer for a cloud-based software development project with the initial phase currently in progress.

The Technical Writer will provide written product for technical and non-technical audiences in support of an Agile development team, to include but not limited to user guides, API documents, and release notes.

Applicants will submit a writing sample with their application.

Skills and Experience

• Skill Required / Desired Amount Experience 5 years’ experience creating software documentation (user guides, API documents, release notes, etc.)
• Required 5 Years Ability to tailor content for both technical and non-technical audiences
• Required 5 Years Proficiency in organizing complex technical information clearly and logically
• Required 5 Years Expert in the use of MS Word, Google Docs, Confluence, or similar tools
• Required 5 Years Knowledge of Markdown, HTML/CSS
• Required 5 Years Proficiency with Adobe Acrobat, SnagIT, or similar tools for visuals
• Required 5 Years Experience with Git or other version control systems at the contributor or read only level and documentation platforms such as GitBook
• Required 5 Years Understanding of Scrum/Agile methodology
• Required 5 Years Familiarity with REST APIs, JSON, and software architecture concepts
• Required 5 Years Ability to read code snippets
• Required 5 Years Excellent grammar, clarity and attention to detail in written products
• Required 5 Years Ability to interview subject matter experts (SMEs) and distill complex information
• Required 5 Years Strong versioning and documentation review practices
• Required 5 Years Experience writing for software products (SaaS, desktop, or mobile)
• Required 5 Years Experience with UX writing highly desirable Highly desired 5 Years
• Required 5 Years Familiarity with diagramming tools (Lucidchart, Draw.io, etc.) highly desired Required 5 Years
• Required 5 Years