Job Description
Job Description
Job Title: Technical Writer
Location: Richmond, VA 23219
Contract Duration: 5 months
Job Description:
Our client is seeking an experienced Technical Writer to develop clear, concise, and user-friendly documentation for a cloud-based software development project. The ideal candidate will have a proven track record of translating complex technical information into accessible language for both technical and non-technical audiences. This role involves creating a style guide and producing various technical documents to support an Agile development team. You will work closely with developers, product managers, and subject matter experts (SMEs) to ensure that documentation aligns with project goals and standards.
Responsibilities:
- Translate complex technical concepts into clear, accessible language for diverse audiences.
- Collaborate with developers, product managers, and SMEs to create user guides, API documentation, release notes, and other technical documents.
- Maintain version control and ensure proper documentation review practices.
- Ensure all documentation complies with agency standards, accessibility requirements, and formatting guidelines.
- Manage multiple documentation projects and adhere to established deadlines.
- Ensure consistency in documentation throughout the development lifecycle.
Skills Required:
The ideal candidate must have at least 5 years of experience in technical writing, preferably within a government or technology environment. Strong expertise is required in using tools like MS Word, Google Docs, Confluence (5+ years), and proficiency with Adobe Acrobat, SnagIT, or similar tools for visuals. Experience with version control systems like Git and documentation platforms such as GitBook is also necessary. A solid understanding of Scrum/Agile methodology, and familiarity with REST APIs, JSON, and software architecture concepts is essential. The ability to read code snippets and create, edit, and maintain various technical documents, including user guides, manuals, and SOPs, is required. Additional experience with government documentation standards and accessibility compliance is highly desirable. Familiarity with diagramming tools (e.g., Lucidchart, Draw.io), UX writing, and basic knowledge of Markdown, HTML/CSS will be advantageous. A Bachelor’s degree in a relevant field (English, Technical Communication, Computer Science) is also required.
Required Qualifications:
- Bachelor’s degree in English, Technical Communication, Computer Science, or a related field
- 5+ years of experience in technical writing, preferably in a government or technology environment
- Expertise in MS Word, Google Docs, Confluence or similar tools
- Proficiency with Adobe Acrobat, SnagIT or similar for visuals
- Experience with Git or other version control systems and documentation platforms like GitBook
- Knowledge of Scrum/Agile methodology
- Familiarity with REST APIs, JSON, and software architecture concepts
- Ability to read code snippets
- Strong written and verbal communication skills
- Experience creating, editing, and maintaining technical documentation (user guides, manuals, SOPs)
- Ability to interview SMEs and distill complex information into clear documentation
- Familiarity with government documentation standards and accessibility compliance (highly desirable)
- Experience with diagramming tools (Lucidchart, Draw.io) and UX writing (highly desirable)
- Basic knowledge of Markdown, HTML/CSS (highly desirable)
vTech Solution Inc. is a Managed IT Services firm headquartered in Washington, DC. They specialize in a range of services including cloud computing, managed network security, and cybersecurity. Their primary focus is on providing human-centered IT solutions for government and business sectors, including federal, state, local, and education (SLED) groups, as well as commercial organizations.
vTech Solution offers services such as:
- Managed Security Services: Implementing zero-trust security frameworks to prevent cyber threats in real-time.
- Multi-cloud Management Services: Helping businesses digitally transform with smart cloud technologies.
- Infrastructure Managed Services: Creating resilient and secure infrastructure management.
- Professional Services: Providing expertise for mission-critical programs.
- Productivity and Communications: Ensuring secure and confident business connectivity from anywhere