The IT Technical Writer will be responsible for the following:
Communication and Document Development
Create, update and maintain application, website and program-related
documentation, including work instructions and process flows.
Work with relevant stakeholders and technical owners to generate documents or
revise/update previously published documents, as necessary.
Update document repositories and document naming convention for
standardization.
Review, format and proofread technical procedure documents; provide
completed documents to OIT or agency customers for final review and approval.
Produce high-quality documentation that is appropriate for its intended
audience.
Document procedures, use cases, requirements and technical designs.
Create process flows, networking and infrastructure diagrams.
Create and edit documents and diagrams using Google or Microsoft applications,
such as Word, Visio and PowerPoint and/or their Google equivalents.
Work collaboratively with a team of analysts, developers, engineers and other IT
security professionals.
Work with contributors to resolve content issues or gaps.
Create and/or organize material and complete writing assignments according to
specified standards regarding order, clarity, conciseness, style and terminology.
Work directly with business and system subject matter experts (SMEs) to ensure
communication to OIT and agency customer stakeholders accurately reflect
current policies and procedures and up-to-date business and system processes.
Develop documentation that translates source materials of a technical nature
into user-friendly language without compromising the accuracy and completeness
of the translated source materials.
Knowledge Building
Have and maintain expert knowledge of common business applications, such as
Microsoft Office and Adobe Acrobat.
Have and maintain expert knowledge in the application of commonly accepted
style guidelines and writing practices as prescribed in the publication use as The
Associated Press Stylebook.
Expert in the application of commonly accepted concepts and practices specific
to technical writing for IT-related systems, ecosystems, applications, websites
and programs.
Continually improve and apply up-to-date technical writing skills.
Qualifications
The IT Technical Writer should possess the following qualifications:
Education and Experience:
Bachelor's degree: A bachelor's degree in English, journalism, communications,
technical writing, computer science or a related field is often preferred. However,
equivalent experience combined with strong writing skills may be considered.
Proven experience: Minimum of three years of demonstrable experience in
technical writing, preferably in an IT environment (e.g., user manuals; online help;
white papers; training materials; system administration guides; network, security,
database documentation; release notes; process documentation; API
documentation).
Skills and Knowledge:
Excellent writing and editing skills: Demonstrated ability to write clear, concise
and accurate technical documentation that is easy for the target audience to
understand.
Strong technical aptitude: Demonstrated comfortability learning and understanding
complex technical concepts and then explaining them in a simple way. Preferred:
Prior experience with IT systems, software development or networking.
Understanding of the software development lifecycle (SDLC): Demonstrated
knowledge of how software is designed, developed and tested.
Ability to work independently and as part of a team: Demonstrated ability to work
independently on assigned projects and collaborate effectively with developers,
engineers, product managers and other stakeholders.