5+ years creating software documentation (user guides, API documents, release notes)
Experience tailoring content for both technical and non-technical audiences
Proficient in organizing complex technical information logically
Expert in MS Word, Google Docs, Confluence, or similar tools
Knowledge of Markdown, HTML/CSS
Proficiency with Adobe Acrobat and SnagIT for visuals
Experience with Git or other version control systems in documentation context
Understanding of Scrum/Agile methodology
Familiarity with REST APIs, JSON, and software architecture concepts
Ability to read code snippets
Strong grammar, clarity, and detail orientation in writing
Responsibilities
Create comprehensive documentation for technical and non-technical users
Collaborate with Agile development teams to gather information
Develop user guides, API documentation, and release notes
Tailor content to suit various audience levels
Utilize tools for visuals and effective document presentation
Conduct interviews with subject matter experts to clarify details
Implement strong versioning and review practices for documentation
Benefits
Ability to work in a dynamic and innovative tech environment
Gain experience in cloud-based software development projects
Collaborative Agile team setting
Opportunity to enhance documentation skills across various platforms
Exposure to cutting-edge technology and methodologies
Full 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. 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 Familiarity with diagramming tools (Lucidchart, Draw.io, etc.) highly desired Required 5 Years Question 1 Commonwealth of Virginia security policies prohibit the use of offshore IT contractors. Do you attest to the fact that your candidate will physically reside within the US for the duration of the assignment? Question 2 Please list candidate's email address. Question 3 In what City and State is your candidate currently located? Question 4 Please make sure to add a writing sample with your submittal. It can be in a separate document from the resume.