Back to jobs
CDM Smith

Intermediate Software Technical Writer

Posted 5 days ago

Job Description

CDM Smith is seeking an Intermediate Technical Writer to join our Digital Engineering Solutions team.
This individual will be part of the Development group within the Digital Engineering Solutions team,
responsible for creating, maintaining, and enhancing technical documentation that supports cloud-based
solutions and CI/CD pipeline processes. The technical writer will ensure that software development and
operations teams have clear, accurate, and accessible documentation to facilitate collaborative work. An
ideal candidate will be a critical thinker, proactive, and highly interested in communicating new technologies
and methods effectively. This individual must demonstrate exceptional abilities in producing documentation
for AEC initiatives that incorporate cutting-edge technologies. As a member of the Digital Engineering
Solutions team, the Documentation group will participate in research and development efforts, providing
guidance and oversight into documentation practices at CDM Smith and supporting the communication of
innovative ideas and new products arising from across the company. The ideal candidate must have
extensive experience in technical writing and exhibit a commitment to continuous improvement and a
passion for delivering high-quality, impactful documentation.
The following are the key responsibilities for this position:
• Take responsibility for the project and work independently in a collaborative environment.
• Develop, organize, and maintain Tier 0 content, ensuring that basic troubleshooting information is
easily accessible and up-to-date for users and support teams.
• Develop, script, and produce training videos that demonstrate the application and benefits of AI
search content tags.
• Create, update, and maintain online help articles, user guides, and quick reference materials related
to AI search content tagging functionalities.
• Collaborate with subject matter experts to gather technical information and translate complex
concepts into user-friendly content
• Create, update, and manage knowledge base articles that address common user questions, issues,
and product features.
• Work with multimedia tools to integrate visuals, screen captures, and interactive elements into
training materials
• Review application recordings (e.g., screen captures, session logs) to extract relevant workflows and
translate them into user guides and Tier 0 documentation for the self-service knowledge base.
• Write clear, concise, and user-focused user guides and manuals tailored to different audience levels,
from novice to advanced users.
• Produce detailed application usage guides and installation instructions, including step-by-step
procedures, screenshots, and diagrams where appropriate.
• Collaborate with product managers, developers, customer support, and subject matter experts to
gather and validate technical information.
• Ensure all documentation adheres to company standards for style, clarity, and accuracy.
• Continuously review and update documentation based on user feedback, product updates, and
emerging needs.
• Support the creation of multimedia content (e.g., videos, tutorials) to enhance the user’s experience
when necessary.
• Participate in peer reviews and contribute to the improvement of documentation processes and
templates.
Skills and Abilities:
• Ability to work independently while collaborating effectively with a team
• Technical Writing Expertise: Proven experience in developing technical documentation for software
applications, preferably in a Tier 0 or knowledge base context.
• Exceptional written and verbal communication skills with the ability to explain complex concepts in a
simple, clear, and concise manner.
• Strong attention to detail, ensuring accuracy, consistency, and quality in all documentation.
• Comfortable working with various software tools, documentation platforms, and graphic editing tools
(e.g., Markdown, Confluence, MS Office, and Snagit).
• Proficiency in video production, including scripting, recording, editing, and publishing instructional
videos.
• Strong understanding of content management systems and documentation standards.
• Familiarity with AI search technologies, content tagging, and related terminologies.
• Ability to learn new technologies quickly and explain them to non-technical audiences.
• Ability to work effectively with cross-functional teams, including engineers, product managers, and
customer support.
• Strong analytical and research skills to gather information from multiple sources and synthesize it into
coherent documentation.
• Capable of managing multiple documentation projects simultaneously and meeting deadlines.
• Understanding end-user needs and the ability to anticipate and address common pain points through
documentation.
• Ability to support enterprise-class applications and a successful track record of managing priorities
and resources personally.
• Good understanding of applications and system dependencies.
• Discipline in keeping documentation current and accurate.
• Ability to clearly explain the cost information to the nontechnical stakeholders.
• Excellent communication and collaboration skills for working with cross-functional teams.
• Excellent written and verbal communication skills in American English.
• Strong problem‑solving and critical‑thinking abilities.
• Willingness to learn new technologies, tools, and product features as required.
• Willingness to participate in on‑call or rotational support schedules.
• Willingness to learn new technologies and tools.
Intermediate Software Technical Writer at CDM Smith | Renata