Jobs · Marketing · Maryland

Sr. Technical Writer

Contiem · Annapolis, MD · 1 mo ago
MarketingFull-time
We need to output HTML fragment with sections: headings

for sections like About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule. We must only include sections that have real specific content. The posting includes: About Us (mission, about us) maybe "About the role"? There's "Position Summary". Could map to "About the role". Responsibilities: "Essential Duties & Responsibilities". Requirements: "Experience And Skills". Skills: maybe "Preferred Skills & Qualifications". Benefits: "Job Benefits". Pay: not specified (only final compensation offer determined by factors... but no specific numbers). According to rule: never create Pay/Schedule/Benefits sections unless posting actually states them. Pay not stated, so omit Pay section. Schedule not stated, omit. Benefits: we have details, so include Benefits section. We also need to include maybe "About Us" as a section? The instruction says use headings for section headings (e.g. About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule). It doesn't forbid other headings? It says use

for section headings (e.g. About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule). Likely we should stick to those headings only. So we need to map content to those headings. We have: - About the role: could include Position Summary and maybe Mission/About Us? The "About the role" heading likely corresponds to position summary. We'll put Position Summary content there. - Responsibilities: Essential Duties & Responsibilities. - Requirements: Experience And Skills (mandatory requirements). Could also include "U.S. citizenship" etc. - Qualifications: maybe not separate; but we have Preferred Skills & Qualifications. Could treat as Qualifications? The instruction list includes Qualifications as a possible heading. We could put Preferred Skills & Qualifications under Qualifications. Or we could have Skills section for preferred skills. But we have both Requirements and Preferred Skills & Qualifications. We could map Requirements to mandatory experience/skills, and Skills to preferred skills. Qualifications maybe not needed. But we need to avoid thin sections. Let's decide: Use Requirements for mandatory experience/skills. Use Skills for preferred skills & qualifications. Omit Qualifications section. - Benefits: Job Benefits. We must not repeat job title as heading. No Job ID etc. We need to preserve all substantive information. So we need to include all bullet points etc. Use
  • for any list of duties/requirements/benefits. For prose use

    . We need to extract content. Let's parse: Job Description (first paragraph) about compensation: "The final compensation offer will be determined by factors such as the candidate’s skills, qualifications, experience, geographic location, and other relevant factors." This is about compensation but not specific numbers. According to rule: never create Pay/Schedule/Benefits sections unless posting actually states them. This is a statement about compensation but not specific. Should we include it? It's not a specific pay figure, but it's about compensation. The rule says: never create Pay/Schedule/Benefits sections unless the posting actually states them. It doesn't say we cannot include compensation prose elsewhere. Could we include it under a generic paragraph? Possibly we could include it in a

    under About the role or somewhere else. But we must not create a Pay section. So we can include that sentence as a paragraph somewhere, maybe under About the role or a general note. However, the instruction says: "Prefer a few substantive sections over many thin ones." Including a paragraph about compensation may be okay. But we need to preserve ALL substantive information. So we need to include that sentence somewhere. Also "Our Mission" paragraph etc. That's about the company. Could be included under About the role? Might be better to have a separate section like "About the company" but not in allowed headings. However we could incorporate it into About the role or maybe we could add a heading "About Us"? Not in list but maybe allowed? The instruction says use

    for section headings (e.g. About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule). The "e.g." suggests those are examples, not exclusive list. But they say "Use

    for section headings (e.g. About the role, Responsibilities, Requirements, Qualifications, Skills, Benefits, Pay, Schedule)." It implies we should use those headings for sections. It might be okay to use other headings if needed, but better to stick to those. We could put mission/about us under About the role as prose. Thus About the role section will contain: Mission, About Us, Position Summary, compensation statement. Responsibilities: list of duties. Requirements: mandatory experience and skills (the bullet list under Experience And Skills). We'll need to convert each line into
  • . Skills: preferred skills & qualifications (the list under Preferred Skills & Qualifications). We'll convert each line into
  • . Benefits: list under Job Benefits. We must not include boilerplate like "Please note, this job description does not cover..." and EEO statement. Remove those. Also remove duplicated lines. Now craft HTML. We'll start with

    About the role

    then paragraphs. Paragraph 1: Our Mission: "We aim to be the leading provider of content management software and expertise, helping clients create, manage, publish, and deliver high-value content." Paragraph 2: About Us: "Contiem, Inc. is a global Component Content Management System (CCMS) and expertise partner. We specialize in creating, managing, and delivering high-value content - technical documentation, eLearning, online help, visualizations, training materials, etc. We continuously challenge the status quo and empower organizations by delivering effective content solutions that help clients achieve their business objectives. Contiem headquarters is located in Annapolis, MD, with additional locations in the US and internationally in Sutton, UK, Chennai, India, and Sydney, Australia. Our elite team of subject matter experts works closely with clients to assess, optimize, and transform their content objectives and operations. Our global team allows us to support clients in 40 countries, including many of the world's largest companies and iconic brands, from various industries such as Publishing, Consumer Products, Healthcare, Technology, and Financial Services." Paragraph 3: Position Summary: "Contiem is seeking a Senior Technical Writer to lead and enhance the quality of documentation across our diverse client portfolio. This position requires someone who excels at managing multiple projects and embraces continuous learning. The ideal candidate brings 15+ years of technical writing experience, thrives in a fast-paced environment, and can confidently support clients with varying standards and expectations. They demonstrate strong writing skills and the ability to adapt their expertise to evolving client needs." Paragraph 4: Compensation statement: "The final compensation offer will be determined by factors such as the candidate’s skills, qualifications, experience, geographic location, and other relevant factors." Now Responsibilities:

    Responsibilities

    then
      with each duty. List from Essential Duties & Responsibilities: - Take a big-picture view of large amounts of content, determining the content information model and the best way to simplify the authoring process for this content. - Collaborate with subject matter experts (SMEs), project managers, and the writing team to ensure the documentation aligns with the prescribed standards and is communicated to the appropriate audience. - Lead documentation projects from planning through publication. Effectively manage timelines, especially when handling multiple projects or clients. This includes keeping the project managers informed of developments and roadblocks. - Create and update technical documentation for assigned products and projects for clients as required. Documentation could include Product Manuals, IOMs, SOPs, software user guides, and online help resources such as FAQs, knowledge base articles, and help desk content. - Ensure documents are accurate and follow the clearly defined standards by the client and Contiem. - Proofread their peers’ work, following Contiem or client guidelines, when applicable. Provide appropriate, comprehensive feedback and accept and incorporate feedback into their own work. - Utilize content management systems to create and manage documentation. - Advocate for the user experience by ensuring documentation is intuitive, helpful, and aligned with product design. - Mentor and help develop the skill sets of junior writers to contribute to the growth of the documentation team. - Learn new skills and implement new practices and procedures as required by Contiem or the client. - Be detail-oriented and follow the best practices and principles of good technical writing. - Other duties as assigned. We need to keep each as
    • . Ensure punctuation inside. Now Requirements:

      Requirements

      then
        with each item from Experience And Skills. List: - U.S. citizenship. - Bachelor’s degree in technical writing, journalism, communications, or related field. - 15+ years of experience in technical writing, with technical writing being your primary job function. - Aptitude for understanding mechanical and electronic products. - Experience with researching and gathering relevant technical data from subject matter experts such as engineers, field service personnel, and developers, as well as from internal documents such as CAD drawings and design documents. - Experience using at least one of the following applications: oXygen Editor, Arbortext, or XMetal. - Experience with writing documentation in DITA/XML. - In-depth knowledge of standards and best practices for writing assembly, installation, operation, and maintenance documentation. - Possess excellent interpersonal and general business communication skills - Proven ability to write for both technical and non-technical audiences. - Experience working independently as well as in a team-oriented, collaborative environment. - Proficiency working in an environment driven by budget, scope, and deadlines across multiple clients/projects. - Proficient in using the following applications and technologies: - Component Content Management Systems - XML editor such as oXygen, Arbortext or XMetal - DITA-OT - HTML - DITA/XML - CSS We need to split the last bullet into sub-items? The instruction: Use
        • for any list of duties/requirements/benefits. For nested lists maybe we can keep as separate
        • items. We'll flatten: each bullet as
        • . For the "Proficient in using the following applications and technologies:" we can treat as a heading? But we can't add extra headings. Better to make it a
        • with the phrase and then a nested
            for the subitems. That's still a list. Acceptable. Thus:
          • Proficient in using the following applications and technologies:
            • Component Content Management Systems
            • XML editor such as oXygen, Arbortext or XMetal
            • DITA-OT
            • HTML
            • DITA/XML
            • CSS
          • Now Skills:

            Skills

            then
              for Preferred Skills & Qualifications. List: - Experience in one of the following industries (manufacturing, industrial, government, publishing, healthcare, technology, consumer products, software, IT documentation, and business & financial services). - Additional experience using the following applications and technologies is preferred: - Adobe InDesign - Microsoft Word - Adobe Acrobat Professional - Visual Studio Code, NotePad++ or related editor - Jira and/or GitHub. - REST API’s - JSON - Confluence - Adobe Illustrator, Photoshop - MadCap Flare - Markdown - FrameMaker - Microsoft Visio - Microsoft PowerPoint - Articulate 360 We'll flatten similarly: first bullet as
            • . Then second bullet as
            • with nested
                . Now Benefits:

                Benefits

                then
                  for Job Benefits. List: - 3 weeks of PTO, 8 paid holidays, 5 additional days for life events such as adoption, child

Similar jobs

Sr. Technical Writer

System OneVirginia, United States· 3 wk ago
Marketing$60–$65/hrapply on jobs.systemone.com

Sr. Technical Writer

SupermicroSan Jose, CA· 1 mo ago
Marketing$120k–$150k/yrapply on jobs.supermicro.com