Technical Documentation Engineer

T and T Consulting Services Inc • Silver Spring, MD

3h

About The Position

As a Technical Documentation Engineer, you will be a key player in a national data development project, transforming complex technical information into clear, concise, and user-friendly documentation. You will collaborate closely with subject matter experts, software developers, and product managers to gather information and ensure accuracy in your documentation. Your work will bridge the gap between intricate technical details and end-users, ensuring our data products can be used effectively for as long as they are needed.

Requirements

• Proven ability to quickly learn and understand complex topics.
• Superior written and verbal communication skills, with a keen eye for detail.
• Proven ability to handle multiple projects simultaneously, with an eye for prioritization.
• Previous experience writing documentation and procedural materials for multiple audiences.
• Experience documenting code and database designs.
• Proficiency with Git for version control.
• Demonstrated experience in setting up, customizing, and maintaining documentation websites using tools like Docusaurus.
• Knowledge of Markdown for writing documentation.
• Experience creating technical diagrams using tools that support "diagram as code" (eg. Mermaid) or traditional graphic tools.
• Experience working with engineering teams to improve the user experience: design, UI, and help refine content and create visuals and diagrams for technical support content.

Responsibilities

• Develop comprehensive documentation that meets organizational standards.
• Obtain a deep understanding of products, services, code, and database designs to translate complex information into simple, polished, and engaging content.
• Write user-friendly content that meets the needs of the target audience, providing product insights in a simple language.
• Create, edit, and maintain various types of technical content, including user manuals, online help guides, release notes, and product and project documentation.
• Develop diagrams and visuals (e.g., architecture diagrams, flowcharts, database ERDs) to enhance user understanding and clarify complex technical concepts, potentially using a "diagram as code" approach.
• Document code, including technical specifications and process documentation.
• Document database designs, including schema, table definitions, relationships, and constraints.
• Research, outline, write, and edit new and existing content, working closely with various departments to understand project requirements.
• Independently gather information from subject matter experts to develop, organize, and write procedure manuals, technical specifications, and process documentation.
• Utilize Git for version control and collaboration on documentation.

Benefits

• Competitive benefits package including health, dental, vision, life insurance coverage, 401(k) plan, training programs, accrued paid time off (PTO), performance based monthly & quarterly awards, paid holidays and customer kudo rewards.

What This Job Offers

• Job Type: Full-time
• Career Level: Mid Level
• Education Level: No Education Listed
• Number of Employees: 51-100 employees