Technical Documentation Specialist
Network Designs, Inc. · McLean, VA · 3 wk ago
WritingFull-time
We need to output HTML fragment with sections: About the role? Actually we have "About NDi Network Designs, Inc." but that's company description. The instruction: Use for section headings (e.g. About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule). Do NOT repeat the job title as a heading. We need to include sections only when posting has real specific content. We have content: About NDi (company overview) maybe not needed as a heading? Could be "About the role" but we have job description. We could use "About the role" heading and put the job description paragraph. Then "Requirements" heading with list of requirements. "Qualifications And Experience" heading maybe "Qualifications". "Preferred Qualifications" could be under Qualifications or separate? Could combine but better separate? The instruction: prefer few substantive sections over many thin ones. Could have sections: About the role, Responsibilities, Requirements, Qualifications, Benefits. Pay and Schedule not present (no specifics). So omit those.
We need to use
for section headings (e.g. About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule). Do NOT repeat the job title as a heading. We need to include sections only when posting has real specific content. We have content: About NDi (company overview) maybe not needed as a heading? Could be "About the role" but we have job description. We could use "About the role" heading and put the job description paragraph. Then "Requirements" heading with list of requirements. "Qualifications And Experience" heading maybe "Qualifications". "Preferred Qualifications" could be under Qualifications or separate? Could combine but better separate? The instruction: prefer few substantive sections over many thin ones. Could have sections: About the role, Responsibilities, Requirements, Qualifications, Benefits. Pay and Schedule not present (no specifics). So omit those.
We need to use - for any list of duties/requirements/benefits. So for Requirements list, Qualifications list, Responsibilities list, Benefits list.
We must preserve all substantive information, not invent or summarize away detail. Remove boilerplate: cookie/navigation/legal/EEO/equal-opportunity/scam-warning boilerplate, duplicated lines, application instructions. At end there is "Apply Now: ..." which is application instruction, should be removed. Also "Veterans First Commitment" and "Our Commitment" maybe EEO boilerplate; we should remove? It's about veterans commitment and EEO statement. Likely considered boilerplate; remove. Also "Military Veterans Encouraged to Apply." maybe keep? It's not boilerplate? Might be considered EEO; but it's a statement encouraging veterans. Might be considered EEO; but it's not a legal disclaimer? Safer to remove? The instruction: remove EEO/equal-opportunity/scam-warning boilerplate. So remove that line. Also "Veterans First Commitment" maybe also EEO? It's about veterans commitment; could be considered EEO. Safer to remove.
We need to keep substantive content: company overview, job description, requirements, qualifications, responsibilities, benefits.
We must not repeat job title as heading. So we won't have heading for "Technical Documentation Specialist". We'll use "About the role" heading and include job description paragraph.
Now craft HTML:
About the role
NDi is seeking a Technical Documentation Specialist to support the FAA Chief Data Office Enterprise Information & Data Integration Program (EIDIP). This role develops, edits, organizes, and sustains clear technical and operational documentation for enterprise platforms, modernization initiatives, governance activities, security processes, software delivery, AI/ML capabilities, and user support.
Then maybe another paragraph about company? Could be separate "About NDi" but not in list of headings. Could incorporate into About the role? Might be better to have a separate section "About NDi" but not in allowed headings list; but we could still use for any heading? The instruction says use for section headings (e.g. About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule). It gives examples but not exclusive; we could use other headings but they'd be non-standard. Safer to stick to those headings. So we can put company overview in a
under About the role or maybe a separate
before.
We'll include company overview as a paragraph before the About the role heading? The instruction: Output ONLY the HTML fragment. No restrictions on having multiple
before headings. We'll put a brief intro paragraph about NDi.
Then Responsibilities heading with
- each duty.
Requirements heading with
- each requirement.
Qualifications heading with
- each qualification (including both required and preferred? Could separate but we can combine required qualifications under Qualifications and maybe add a note about preferred? But we need preserve all detail. Could have two sub-sections? Might be thin. Better to have Qualifications heading and list both required and preferred qualifications as items, maybe mark preferred with "(Preferred)". That preserves detail.
Benefits heading with
- each benefit.
We must not include Pay or Schedule.
Now extract details:
Company overview: "About NDi Network Designs, Inc. (NDi) is a leading Federal contractor that specializes in designing, developing, and delivering information technology and network solutions for government customers. Founded in 1985, NDi's firmly defined core values have driven all aspects of the business, which have been paramount to our company's success and the establishment of an enjoyable workplace atmosphere. At NDi, we believe that our people are the cornerstone of our success, and we value collaboration, career growth, and winning ideas."
Job description paragraph: as above.
Requirements list:
- U.S. Citizenship is required
- Must be able to obtain and maintain a Public Trust clearance
- This position is remote, candidate must reside in one of the following states: AL, AZ, DC, FL, GA, ID, MD, MS, NJ, NC, OK, OH, PA, SC, TN, TX, UT, VA, WV
- Occasional travel may be required.
- Candidates should be able to attend meetings at FAA facilities and other locations throughout the Continental United States (CONUS) as required.
- Must be available during Eastern Time (ET) business hours to support program needs and FAA coordination.
Qualifications (required):
- Bachelor's degree in any field or discipline
- Minimum 5 years of relevant technical writing, documentation, communications, or related experience
- Experience creating technical documentation and diagrams and applying professional documentation standards.
- Experience translating business processes into workflows and developing security, integration, design, development, and implementation documentation.
- Experience researching, analyzing, compiling, writing, and editing diverse policy, technical, statistical, demographic, and financial information.
- Strong proficiency with Microsoft Office and SharePoint.
- Ability to translate complex technical content into clear documentation for technical and nontechnical audiences.
- Ability to obtain and maintain FAA Contractor Personnel Suitability.
- Strong written, verbal, organizational, research, editing, and cross-functional collaboration skills.
Preferred qualifications (list):
- FAA or other federal experience and familiarity with federal documentation, accessibility, records-management, security, and review standards.
- Experience supporting Agile, cloud, data, analytics, AI/ML, cybersecurity, governance, or enterprise modernization programs.
- Experience with diagramming, knowledge-management platforms, document repositories, and version-controlled technical content.
- Experience creating user training, onboarding, self-service, and knowledge-transfer materials.
Responsibilities list:
- Develop and maintain architecture documentation, technical design documents, SOPs, runbooks, user guides, security artifacts, process documentation, training materials, and knowledge-base content.
- Translate complex technical, policy, process, statistical, demographic, and financial information into clear, accurate, audience-appropriate documentation.
- Interview architects, engineers, security practitioners, analysts, program managers, product owners, and users to collect and validate source information.
- Document business processes, workflows, security and integration requirements, design decisions, development procedures, implementation steps, operational practices, and support processes.
- Edit professional documents for content, structure, consistency, readability, accessibility, format, flow, and technical integrity.
- Determine the suitability and level of detail of material for executive, technical, operational, and end-user audiences and identify missing or incomplete content.
- Maintain version-controlled repositories, templates, diagrams, document standards, review cycles, release updates, and approval records.
- Support project and program reports, procedures, presentations, meeting materials, training, transition, onboarding, and knowledge-transfer activities.
- Collaborate with Agile and technical delivery teams to ensure documentation remains synchronized with platform, application, security, governance, and operational changes.
Benefits list:
- Comprehensive health, dental, vision, pet, and legal insurance.
- 401(k) retirement matching.
- Paid leave.
- Paid holidays.
- Health and wellness programs.
- Employer-paid life and disability insurance.
- Professional development.
- Education benefits.
- Much more to ensure team has resources they need to thrive on and off the job.
We should not include "Much more" maybe it's vague but it's part of benefits description; we can keep as a bullet.
Now produce HTML.
We need to ensure no extra text outside HTML. Provide only fragment.
Let's craft:
About NDi Network Designs, Inc. (NDi) is a leading Federal contractor that specializes in designing, developing, and delivering information technology and network solutions for government customers. Founded in 1985, NDi's firmly defined core values have driven all aspects of the business, which have been paramount to our company's success and the establishment of an enjoyable workplace atmosphere. At NDi, we believe that our people are the cornerstone of our success, and we value collaboration, career growth, and winning ideas.
About the role
NDi is seeking a Technical Documentation Specialist to support the FAA Chief Data Office Enterprise Information & Data Integration Program (EIDIP). This role develops, edits, organizes, and sustains clear technical and operational documentation for enterprise platforms, modernization initiatives, governance activities, security processes, software delivery, AI/ML capabilities, and user support.
Responsibilities
- Develop and maintain architecture documentation, technical design documents, SOPs, runbooks, user guides, security artifacts, process documentation, training materials, and knowledge-base content.
- Translate complex technical, policy, process, statistical, demographic, and financial information into clear, accurate, audience-appropriate documentation.
- Interview architects, engineers, security practitioners, analysts, program managers, product owners, and users to collect and validate source information.
- Document business processes, workflows, security and integration requirements, design decisions, development procedures, implementation steps, operational practices, and support processes.
- Edit professional documents for content, structure, consistency, readability, accessibility, format, flow, and technical integrity.
- Determine the suitability and level of detail of material for executive, technical, operational, and end-user audiences and identify missing or incomplete content.
- Maintain version-controlled repositories, templates, diagrams, document standards, review cycles, release updates, and approval records.
- Support project and program reports, procedures, presentations, meeting materials, training, transition, onboarding, and knowledge-transfer activities.
- Collaborate with Agile and technical delivery teams to ensure documentation remains synchronized with platform, application, security, governance, and operational changes.
Requirements
- U.S. Citizenship is required
- Must be able to obtain and maintain a Public Trust clearance
- This position is remote, candidate must reside in one of the following states: AL, AZ, DC, FL, GA, ID, MD, MS, NJ, NC, OK, OH, PA, SC, TN, TX, UT, VA, WV
- Occasional travel may be required.
- Candidates should be able to attend meetings at FAA facilities and other locations throughout the Continental United States (CONUS) as required.
- Must be available during Eastern Time (ET) business hours to support program needs and FAA coordination.
Qualifications
- Bachelor's degree in any field or discipline
- Minimum 5 years of relevant technical writing, documentation, communications, or related experience
- Experience creating technical documentation and diagrams and applying professional documentation standards.
- Experience translating business processes into workflows and developing security, integration, design, development, and implementation documentation.
- Experience researching, analyzing, compiling, writing, and editing diverse policy, technical, statistical, demographic, and financial information.
- Strong
About the role
NDi is seeking a Technical Documentation Specialist to support the FAA Chief Data Office Enterprise Information & Data Integration Program (EIDIP). This role develops, edits, organizes, and sustains clear technical and operational documentation for enterprise platforms, modernization initiatives, governance activities, security processes, software delivery, AI/ML capabilities, and user support.
Then maybe another paragraph about company? Could be separate "About NDi" but not in list of headings. Could incorporate into About the role? Might be better to have a separate section "About NDi" but not in allowed headings list; but we could still use for any heading? The instruction says use for section headings (e.g. About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule). It gives examples but not exclusive; we could use other headings but they'd be non-standard. Safer to stick to those headings. So we can put company overview in a
under About the role or maybe a separate
before. We'll include company overview as a paragraph before the About the role heading? The instruction: Output ONLY the HTML fragment. No restrictions on having multiple
before headings. We'll put a brief intro paragraph about NDi. Then Responsibilities heading with
- each duty.
Requirements heading with
- each requirement.
Qualifications heading with
- each qualification (including both required and preferred? Could separate but we can combine required qualifications under Qualifications and maybe add a note about preferred? But we need preserve all detail. Could have two sub-sections? Might be thin. Better to have Qualifications heading and list both required and preferred qualifications as items, maybe mark preferred with "(Preferred)". That preserves detail.
Benefits heading with
- each benefit.
We must not include Pay or Schedule.
Now extract details:
Company overview: "About NDi Network Designs, Inc. (NDi) is a leading Federal contractor that specializes in designing, developing, and delivering information technology and network solutions for government customers. Founded in 1985, NDi's firmly defined core values have driven all aspects of the business, which have been paramount to our company's success and the establishment of an enjoyable workplace atmosphere. At NDi, we believe that our people are the cornerstone of our success, and we value collaboration, career growth, and winning ideas."
Job description paragraph: as above.
Requirements list:
- U.S. Citizenship is required
- Must be able to obtain and maintain a Public Trust clearance
- This position is remote, candidate must reside in one of the following states: AL, AZ, DC, FL, GA, ID, MD, MS, NJ, NC, OK, OH, PA, SC, TN, TX, UT, VA, WV
- Occasional travel may be required.
- Candidates should be able to attend meetings at FAA facilities and other locations throughout the Continental United States (CONUS) as required.
- Must be available during Eastern Time (ET) business hours to support program needs and FAA coordination.
Qualifications (required):
- Bachelor's degree in any field or discipline
- Minimum 5 years of relevant technical writing, documentation, communications, or related experience
- Experience creating technical documentation and diagrams and applying professional documentation standards.
- Experience translating business processes into workflows and developing security, integration, design, development, and implementation documentation.
- Experience researching, analyzing, compiling, writing, and editing diverse policy, technical, statistical, demographic, and financial information.
- Strong proficiency with Microsoft Office and SharePoint.
- Ability to translate complex technical content into clear documentation for technical and nontechnical audiences.
- Ability to obtain and maintain FAA Contractor Personnel Suitability.
- Strong written, verbal, organizational, research, editing, and cross-functional collaboration skills.
Preferred qualifications (list):
- FAA or other federal experience and familiarity with federal documentation, accessibility, records-management, security, and review standards.
- Experience supporting Agile, cloud, data, analytics, AI/ML, cybersecurity, governance, or enterprise modernization programs.
- Experience with diagramming, knowledge-management platforms, document repositories, and version-controlled technical content.
- Experience creating user training, onboarding, self-service, and knowledge-transfer materials.
Responsibilities list:
- Develop and maintain architecture documentation, technical design documents, SOPs, runbooks, user guides, security artifacts, process documentation, training materials, and knowledge-base content.
- Translate complex technical, policy, process, statistical, demographic, and financial information into clear, accurate, audience-appropriate documentation.
- Interview architects, engineers, security practitioners, analysts, program managers, product owners, and users to collect and validate source information.
- Document business processes, workflows, security and integration requirements, design decisions, development procedures, implementation steps, operational practices, and support processes.
- Edit professional documents for content, structure, consistency, readability, accessibility, format, flow, and technical integrity.
- Determine the suitability and level of detail of material for executive, technical, operational, and end-user audiences and identify missing or incomplete content.
- Maintain version-controlled repositories, templates, diagrams, document standards, review cycles, release updates, and approval records.
- Support project and program reports, procedures, presentations, meeting materials, training, transition, onboarding, and knowledge-transfer activities.
- Collaborate with Agile and technical delivery teams to ensure documentation remains synchronized with platform, application, security, governance, and operational changes.
Benefits list:
- Comprehensive health, dental, vision, pet, and legal insurance.
- 401(k) retirement matching.
- Paid leave.
- Paid holidays.
- Health and wellness programs.
- Employer-paid life and disability insurance.
- Professional development.
- Education benefits.
- Much more to ensure team has resources they need to thrive on and off the job.
We should not include "Much more" maybe it's vague but it's part of benefits description; we can keep as a bullet.
Now produce HTML.
We need to ensure no extra text outside HTML. Provide only fragment.
Let's craft:
About NDi Network Designs, Inc. (NDi) is a leading Federal contractor that specializes in designing, developing, and delivering information technology and network solutions for government customers. Founded in 1985, NDi's firmly defined core values have driven all aspects of the business, which have been paramount to our company's success and the establishment of an enjoyable workplace atmosphere. At NDi, we believe that our people are the cornerstone of our success, and we value collaboration, career growth, and winning ideas.
About the role
NDi is seeking a Technical Documentation Specialist to support the FAA Chief Data Office Enterprise Information & Data Integration Program (EIDIP). This role develops, edits, organizes, and sustains clear technical and operational documentation for enterprise platforms, modernization initiatives, governance activities, security processes, software delivery, AI/ML capabilities, and user support.
Responsibilities
- Develop and maintain architecture documentation, technical design documents, SOPs, runbooks, user guides, security artifacts, process documentation, training materials, and knowledge-base content.
- Translate complex technical, policy, process, statistical, demographic, and financial information into clear, accurate, audience-appropriate documentation.
- Interview architects, engineers, security practitioners, analysts, program managers, product owners, and users to collect and validate source information.
- Document business processes, workflows, security and integration requirements, design decisions, development procedures, implementation steps, operational practices, and support processes.
- Edit professional documents for content, structure, consistency, readability, accessibility, format, flow, and technical integrity.
- Determine the suitability and level of detail of material for executive, technical, operational, and end-user audiences and identify missing or incomplete content.
- Maintain version-controlled repositories, templates, diagrams, document standards, review cycles, release updates, and approval records.
- Support project and program reports, procedures, presentations, meeting materials, training, transition, onboarding, and knowledge-transfer activities.
- Collaborate with Agile and technical delivery teams to ensure documentation remains synchronized with platform, application, security, governance, and operational changes.
Requirements
- U.S. Citizenship is required
- Must be able to obtain and maintain a Public Trust clearance
- This position is remote, candidate must reside in one of the following states: AL, AZ, DC, FL, GA, ID, MD, MS, NJ, NC, OK, OH, PA, SC, TN, TX, UT, VA, WV
- Occasional travel may be required.
- Candidates should be able to attend meetings at FAA facilities and other locations throughout the Continental United States (CONUS) as required.
- Must be available during Eastern Time (ET) business hours to support program needs and FAA coordination.
Qualifications
- Bachelor's degree in any field or discipline
- Minimum 5 years of relevant technical writing, documentation, communications, or related experience
- Experience creating technical documentation and diagrams and applying professional documentation standards.
- Experience translating business processes into workflows and developing security, integration, design, development, and implementation documentation.
- Experience researching, analyzing, compiling, writing, and editing diverse policy, technical, statistical, demographic, and financial information.
- Strong
- each benefit.
We must not include Pay or Schedule.
Now extract details:
Company overview: "About NDi Network Designs, Inc. (NDi) is a leading Federal contractor that specializes in designing, developing, and delivering information technology and network solutions for government customers. Founded in 1985, NDi's firmly defined core values have driven all aspects of the business, which have been paramount to our company's success and the establishment of an enjoyable workplace atmosphere. At NDi, we believe that our people are the cornerstone of our success, and we value collaboration, career growth, and winning ideas."
Job description paragraph: as above.
Requirements list:
- U.S. Citizenship is required
- Must be able to obtain and maintain a Public Trust clearance
- This position is remote, candidate must reside in one of the following states: AL, AZ, DC, FL, GA, ID, MD, MS, NJ, NC, OK, OH, PA, SC, TN, TX, UT, VA, WV
- Occasional travel may be required.
- Candidates should be able to attend meetings at FAA facilities and other locations throughout the Continental United States (CONUS) as required.
- Must be available during Eastern Time (ET) business hours to support program needs and FAA coordination.
Qualifications (required):
- Bachelor's degree in any field or discipline
- Minimum 5 years of relevant technical writing, documentation, communications, or related experience
- Experience creating technical documentation and diagrams and applying professional documentation standards.
- Experience translating business processes into workflows and developing security, integration, design, development, and implementation documentation.
- Experience researching, analyzing, compiling, writing, and editing diverse policy, technical, statistical, demographic, and financial information.
- Strong proficiency with Microsoft Office and SharePoint.
- Ability to translate complex technical content into clear documentation for technical and nontechnical audiences.
- Ability to obtain and maintain FAA Contractor Personnel Suitability.
- Strong written, verbal, organizational, research, editing, and cross-functional collaboration skills.
Preferred qualifications (list):
- FAA or other federal experience and familiarity with federal documentation, accessibility, records-management, security, and review standards.
- Experience supporting Agile, cloud, data, analytics, AI/ML, cybersecurity, governance, or enterprise modernization programs.
- Experience with diagramming, knowledge-management platforms, document repositories, and version-controlled technical content.
- Experience creating user training, onboarding, self-service, and knowledge-transfer materials.
Responsibilities list:
- Develop and maintain architecture documentation, technical design documents, SOPs, runbooks, user guides, security artifacts, process documentation, training materials, and knowledge-base content.
- Translate complex technical, policy, process, statistical, demographic, and financial information into clear, accurate, audience-appropriate documentation.
- Interview architects, engineers, security practitioners, analysts, program managers, product owners, and users to collect and validate source information.
- Document business processes, workflows, security and integration requirements, design decisions, development procedures, implementation steps, operational practices, and support processes.
- Edit professional documents for content, structure, consistency, readability, accessibility, format, flow, and technical integrity.
- Determine the suitability and level of detail of material for executive, technical, operational, and end-user audiences and identify missing or incomplete content.
- Maintain version-controlled repositories, templates, diagrams, document standards, review cycles, release updates, and approval records.
- Support project and program reports, procedures, presentations, meeting materials, training, transition, onboarding, and knowledge-transfer activities.
- Collaborate with Agile and technical delivery teams to ensure documentation remains synchronized with platform, application, security, governance, and operational changes.
Benefits list:
- Comprehensive health, dental, vision, pet, and legal insurance.
- 401(k) retirement matching.
- Paid leave.
- Paid holidays.
- Health and wellness programs.
- Employer-paid life and disability insurance.
- Professional development.
- Education benefits.
- Much more to ensure team has resources they need to thrive on and off the job.
We should not include "Much more" maybe it's vague but it's part of benefits description; we can keep as a bullet.
Now produce HTML.
We need to ensure no extra text outside HTML. Provide only fragment.
Let's craft:
- each qualification (including both required and preferred? Could separate but we can combine required qualifications under Qualifications and maybe add a note about preferred? But we need preserve all detail. Could have two sub-sections? Might be thin. Better to have Qualifications heading and list both required and preferred qualifications as items, maybe mark preferred with "(Preferred)". That preserves detail.
Benefits heading with
- each requirement.
Qualifications heading with