Yesterday
Secret
Early Career (2+ yrs experience)
$80,000 - $90,000
IT - Tech Writing
Washington, DC (On-Site/Office)
Technical Writer – Job Description
Overview:
This position requires the contractor to write and/or edit a variety of technical documents including, but
not limited to, business proposals, reports, user manuals, briefings and presentations, functional
descriptions, system specifications, guidelines, special reports, and other project deliverables to meet
contract requirements.
The contractor will:
•
Develop outlines and drafts for review and approval by technical specialists and project
management, ensuring that final documents meet applicable contract requirements and
regulations.
•
Research and gather technical and background information for inclusion in project
documentation.
•
Consult relevant sources, including library resources, technical and financial documents, and
client and project personnel to verify pertinent guidelines and regulations.
•
Conduct research to enhance understanding of required concepts to create specific documents.
Responsibilities:
•
Determine the needs of end users of technical documentation.
•
Organize and write supporting documents for products, technology, policy, and services in line
with ITIL best practices.
•
Use visual aids such as photographs, drawings, diagrams, animations, and charts to increase
user understanding.
•
Select appropriate mediums (manuals, online content, etc.) for message delivery.
•
Maintain documentation in organized repositories accessible to relevant personnel.
•
Ensure, at minimum, a yearly review of all documentation and perform interim updates as
necessary due to technical or process changes.
•
Submit documentation free of grammatical and spelling errors.
•
Perform research necessary to gain understanding of the concepts to be conveyed, including via
the internet, personnel conversations, or vendor interactions.
•
Participate in activities that support the task, such as meetings, consultations, and documentation
of task-specific requirements.
Technical Writing Tasks Include:
•
Write/edit technical documents such as:
o
Business proposals
o
Reports
o
User manuals
o
Briefings and presentations
o
Functional descriptions
o
System specifications
o
Guidelines and special reports
•
Develop drafts for review/approval by technical staff and project managers.
•
Work closely with both federal employees and contractor support staff.
•
Create/edit enterprise documentation, including:
o
Design documents
o
Installation guides
o
Release notes
o
Online help content
•
Support requirement gathering, meeting facilitation, and documentation reviews.
•
Translate business strategies and customer requirements into detailed specifications, narratives,
flowcharts, and process flows.
•
Research and test web applications for content and documentation accuracy.
•
Prepare diagrams and written content for a variety of technical IT services.
•
Submit effective and concise communications about issues, risks, objectives, and initiatives.
Editorial Responsibilities:
•
Convert complex technical information into understandable terms for different audiences.
•
Conduct editorial reviews, readability analysis, and copy-editing of:
o
Audit reports
o
Correspondence
o
Internal documents
•
Document business workflows, requirements, diagrams, and training material.
•
Schedule and conduct training sessions on new applications.
•
Compare client needs or business processes with available technical solutions.
•
Research business processes and assist in developing project specifications.
•
Track and support development of IT project schedules.
•
Identify and make recommendations for business process improvements.
•
Interface with internal/external customers and IT staff to resolve process-related issues.
•
Document design changes and recommend best practices for performance improvement.
Documentation & Quality Standards:
•
Edit, standardize, or revise documentation to meet established standards.
•
Write program activity reports for internal and Department of Commerce use.
•
Maintain/update business documentation; provide ongoing application support.
•
Create and maintain:
o
User Manuals
o
Job Aids
o
SOPs
o
Memos
o
Meeting Minutes
o
Statements of Work
o
System Security Plans
o
IT Policy and A&A (Assessment & Accreditation) documentation
•
Ensure adherence to documentation methodologies, procedures, and standards.
•
Responsible for development of internal and customer portals.
•
Manage change control processes for documentation.
•
Perform other duties as assigned.
Overview:
This position requires the contractor to write and/or edit a variety of technical documents including, but
not limited to, business proposals, reports, user manuals, briefings and presentations, functional
descriptions, system specifications, guidelines, special reports, and other project deliverables to meet
contract requirements.
The contractor will:
•
Develop outlines and drafts for review and approval by technical specialists and project
management, ensuring that final documents meet applicable contract requirements and
regulations.
•
Research and gather technical and background information for inclusion in project
documentation.
•
Consult relevant sources, including library resources, technical and financial documents, and
client and project personnel to verify pertinent guidelines and regulations.
•
Conduct research to enhance understanding of required concepts to create specific documents.
Responsibilities:
•
Determine the needs of end users of technical documentation.
•
Organize and write supporting documents for products, technology, policy, and services in line
with ITIL best practices.
•
Use visual aids such as photographs, drawings, diagrams, animations, and charts to increase
user understanding.
•
Select appropriate mediums (manuals, online content, etc.) for message delivery.
•
Maintain documentation in organized repositories accessible to relevant personnel.
•
Ensure, at minimum, a yearly review of all documentation and perform interim updates as
necessary due to technical or process changes.
•
Submit documentation free of grammatical and spelling errors.
•
Perform research necessary to gain understanding of the concepts to be conveyed, including via
the internet, personnel conversations, or vendor interactions.
•
Participate in activities that support the task, such as meetings, consultations, and documentation
of task-specific requirements.
Technical Writing Tasks Include:
•
Write/edit technical documents such as:
o
Business proposals
o
Reports
o
User manuals
o
Briefings and presentations
o
Functional descriptions
o
System specifications
o
Guidelines and special reports
•
Develop drafts for review/approval by technical staff and project managers.
•
Work closely with both federal employees and contractor support staff.
•
Create/edit enterprise documentation, including:
o
Design documents
o
Installation guides
o
Release notes
o
Online help content
•
Support requirement gathering, meeting facilitation, and documentation reviews.
•
Translate business strategies and customer requirements into detailed specifications, narratives,
flowcharts, and process flows.
•
Research and test web applications for content and documentation accuracy.
•
Prepare diagrams and written content for a variety of technical IT services.
•
Submit effective and concise communications about issues, risks, objectives, and initiatives.
Editorial Responsibilities:
•
Convert complex technical information into understandable terms for different audiences.
•
Conduct editorial reviews, readability analysis, and copy-editing of:
o
Audit reports
o
Correspondence
o
Internal documents
•
Document business workflows, requirements, diagrams, and training material.
•
Schedule and conduct training sessions on new applications.
•
Compare client needs or business processes with available technical solutions.
•
Research business processes and assist in developing project specifications.
•
Track and support development of IT project schedules.
•
Identify and make recommendations for business process improvements.
•
Interface with internal/external customers and IT staff to resolve process-related issues.
•
Document design changes and recommend best practices for performance improvement.
Documentation & Quality Standards:
•
Edit, standardize, or revise documentation to meet established standards.
•
Write program activity reports for internal and Department of Commerce use.
•
Maintain/update business documentation; provide ongoing application support.
•
Create and maintain:
o
User Manuals
o
Job Aids
o
SOPs
o
Memos
o
Meeting Minutes
o
Statements of Work
o
System Security Plans
o
IT Policy and A&A (Assessment & Accreditation) documentation
•
Ensure adherence to documentation methodologies, procedures, and standards.
•
Responsible for development of internal and customer portals.
•
Manage change control processes for documentation.
•
Perform other duties as assigned.
group id: 91159842
