Negotiable
Outside
Remote
USA
Summary: The Technical Writer will create documentation for both technical and non-technical audiences to support an Agile development team, including user guides, API documents, and release notes. The role requires a strong ability to tailor content and organize complex information clearly. Applicants must submit a writing sample with their application. The position is remote and spans a duration of 12 months.
Key Responsibilities:
- Create user guides, API documents, and release notes for various audiences.
- Collaborate with Agile development teams to gather information and understand product features.
- Tailor content for both technical and non-technical audiences.
- Organize complex technical information clearly and logically.
- Utilize tools such as MS Word, Google Docs, and Confluence for documentation.
- Implement knowledge of Markdown, HTML/CSS in documentation.
- Use Adobe Acrobat, SnagIT, or similar tools for visuals.
- Work with Git or other version control systems for documentation management.
- Understand Scrum/Agile methodology and apply it in documentation processes.
- Interview subject matter experts to distill complex information.
- Maintain strong versioning and documentation review practices.
- Write for software products, including SaaS, desktop, or mobile applications.
- Utilize diagramming tools for documentation as needed.
Key Skills:
- 5 years experience creating software documentation (user guides, API documents, release notes, etc.).
- Ability to tailor content for both technical and non-technical audiences.
- Proficiency in organizing complex technical information clearly and logically.
- Expert in the use of MS Word, Google Docs, Confluence, or similar tools.
- Knowledge of Markdown, HTML/CSS.
- Proficiency with Adobe Acrobat, SnagIT, or similar tools for visuals.
- Experience with Git or other version control systems.
- Understanding of Scrum/Agile methodology.
- Familiarity with REST APIs, JSON, and software architecture concepts.
- Ability to read code snippets.
- Excellent grammar, clarity, and attention to detail in written products.
- Ability to interview subject matter experts (SMEs) and distill complex information.
- Strong versioning and documentation review practices.
- Experience writing for software products (SaaS, desktop, or mobile).
- Experience with UX writing highly desirable.
- Familiarity with diagramming tools (Lucidchart, Draw.io, etc.) highly desired.
Salary (Rate): undetermined
City: undetermined
Country: USA
Working Arrangements: remote
IR35 Status: outside IR35
Seniority Level: undetermined
Industry: IT
Title: Technical Writer
Location: Richmond, VA ( Remote )
Duration: 12 Months
Client: State of Virginia
Job Description:
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.
| Skill | Required / Desired | Amount | of 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 |
Familiarity with diagramming tools (Lucidchart, Draw.io, etc.) highly desired | Required | 5 | Years |