Technical Documentation Specialist

3 weeks ago


Austin, United States FM Search Full time
Job DescriptionJob Description

Technical Documentation Specialist Job Description


Primary Role:

As a Technical Documentation Specialist within the Product team, your daily responsibility entails translating intricate technical concepts into clear, concise documentation that enables engineers to execute their tasks effectively. You will be instrumental in documenting various technical aspects utilizing an array of tools and formats, including Data Flow Diagrams (DFD), Entity-Relationship Diagrams (ERD), Sequence Diagrams, API Documentation, Business Workflow Diagrams, Architecture Diagrams, User Guides, Release Notes, and more. Collaborating closely with stakeholders, Business Analysts, Product Owners, UI/UX designers, and engineering teams, you will ensure a comprehensive understanding of requirements and specifications before the commencement of engineering work. Your pivotal role extends to validating and updating documentation to ensure its accuracy and currency once the engineering teams complete their tasks.

Responsibilities:

Translate complex technical concepts into clear and concise documentation.

Develop and maintain documentation for software products, including technical specifications, user guides, and release notes.

Create and update diagrams and schematics, such as Data Flow Diagrams, Entity-Relationship Diagrams, and Sequence Diagrams.

Write comprehensive API documentation, including endpoint descriptions, parameters, and usage instructions.

Collaborate closely with engineers and other stakeholders to understand technical requirements and ensure documentation accuracy.

Review and edit documentation for clarity, consistency, and adherence to style guidelines.

Manage documentation repositories and version control systems to ensure accessibility and traceability of documentation assets.

Participate in Agile ceremonies, such as sprint planning and backlog refinement, to align documentation efforts with development priorities.

Qualifications/Experience:

Proven experience in technical writing or documentation management, preferably within the software development or IT industry.

Proficiency in documentation tools and software, including Microsoft Office Suite, Adobe Acrobat, Visio, Lucidchart, and documentation automation tools (e.g., Sphinx, Jekyll).

Strong understanding of software development methodologies, particularly Agile, and familiarity with version control systems like Git.

Excellent communication and collaboration skills, with the ability to work effectively in cross-functional teams and interact with stakeholders at various levels.

A detail-oriented mindset committed to producing high-quality documentation that meets industry standards and regulatory requirements.

Experience in creating visually appealing diagrams and illustrations, with knowledge of graphic design principles applied to technical documentation.

Certification in technical writing or a related field (e.g., Certified Professional Technical Communicator) would be advantageous.

Preferred:

Bachelor's degree in Computer Science, Technical Writing, or a related field.

Knowledge of graphic design principles and experience creating visually appealing diagrams and illustrations.

Certification in technical writing or related field (e.g., Certified Professional Technical Communicator).


#zr



  • Austin, United States FM Search Full time

    Job DescriptionJob DescriptionTechnical Documentation Specialist Job DescriptionPrimary Role:As a Technical Documentation Specialist within the Product team, your daily responsibility entails translating intricate technical concepts into clear, concise documentation that enables engineers to execute their tasks effectively. You will be instrumental in...

  • IT Reporting

    3 weeks ago


    Austin, United States Texas Department of Aging & Disability Services Full time

    Job Description: Management Analyst III - IT Reporting & Documentation Specialist **This position is eligible for full-time telework from within the state of Texas** The IT Reporting & Documentation Specialist performs highly advanced, senior-level work for the IT division. The specialist’s work involves helping the division establish, document,...


  • Austin, United States Curative HR LLC Full time

    The Documentation Specialist will manage the many documents, spreadsheets and records that are specific to onboarding, maintaining, and renewing Curative client groups and brokers. This position is responsible for accurate documentation and reporting of all documentation for the account management and implementation...


  • Austin, United States Pinnacle Group, Inc. Full time

    SAP Documentation SpecialistDay 1 Onsite Austin, TX / Sunnyvale, CAHybrid – 3 days Onsite / WeekLong term contractNeed SAP Documentation specialist.Minimum 5+ years’ experience needed.Pay Range: $45/hr - $50/hrThe specific compensation for this position will be determined by a number of factors, including the scope, complexity and location of the role as...


  • Austin, United States Pinnacle Group, Inc. Full time

    SAP Documentation SpecialistDay 1 Onsite Austin, TX / Sunnyvale, CAHybrid – 3 days Onsite / WeekLong term contractNeed SAP Documentation specialist.Minimum 5+ years’ experience needed.Pay Range: $45/hr - $50/hrThe specific compensation for this position will be determined by a number of factors, including the scope, complexity and location of the role as...


  • Austin, United States Pinnacle Group, Inc. Full time

    SAP Documentation SpecialistDay 1 Onsite Austin, TX / Sunnyvale, CAHybrid – 3 days Onsite / WeekLong term contractNeed SAP Documentation specialist.Minimum 5+ years’ experience needed.Pay Range: $45/hr - $50/hrThe specific compensation for this position will be determined by a number of factors, including the scope, complexity and location of the role as...


  • Austin, United States Unicon Pharma Inc Full time

    Job DescriptionJob DescriptionTitle: Document Control SpecialistLocation: Austin, TX Position Summary:The Documentation Control specialist will provide direct support for the electronic and physical incorporation, release and control of documents and Quality Records associated with Client’s operations, development and research...


  • Austin, United States Voya Financial Full time

    Together we fight for everyones opportunity for a better financial future. We will do this together with customers, partners and colleagues. We will fight for others, not against: We will stand up for and champion everyones access to opportunitie Support Specialist, Technical Support, Technical, Specialist, Support, Financial, Technology, Insurance


  • Austin, United States GForce Life Sciences Full time

    Job Details: Internal Job Title: QA Specialist II Duration: 6-month contract Location: Onsite - Austin, TX Special Notes: Will start with the standard Monday - Friday shift for training, and will then move to Wednesday - Saturday shift Responsibilities: This person will ensure the quality of manufactured products and processes per standard operating...


  • Austin, United States GForce Life Sciences Full time

    Job Details: Internal Job Title: QA Specialist IIDuration: 6-month contractLocation: Onsite - Austin, TXSpecial Notes: Will start with the standard Monday - Friday shift for training, and will then move to Wednesday - Saturday shiftResponsibilities: This person will ensure the quality of manufactured products and processes per standard operating processes...


  • Austin, United States GForce Life Sciences Full time

    Job Details: Internal Job Title: QA Specialist IIDuration: 6-month contractLocation: Onsite - Austin, TXSpecial Notes: Will start with the standard Monday - Friday shift for training, and will then move to Wednesday - Saturday shiftResponsibilities: This person will ensure the quality of manufactured products and processes per standard operating processes...


  • Austin, United States GForce Life Sciences Full time

    Job Details: Internal Job Title: QA Specialist IIDuration: 6-month contractLocation: Onsite - Austin, TXSpecial Notes: Will start with the standard Monday - Friday shift for training, and will then move to Wednesday - Saturday shiftResponsibilities: This person will ensure the quality of manufactured products and processes per standard operating processes...


  • Austin, United States Allied Consultants (Texas) Full time

    Overview: Allied Consultants, Inc. is an Austin-based firm which has for 32 years been a premier provider of technical and business professionals to clients in Texas. We are currently seeking an experienced Technical Training Specialist to be a key resource on a technical services team. Allied Consultants offers its family of consultants excellent rates, a...


  • Austin, United States Texas Department of Aging & Disability Services Full time

    Job Description: The Technical Communication Specialist plans, develops, writes, edits, and coordinates submittal of documents required to obtain project approval and financial participation from state and federal oversight authorities. Provides consultation regarding state and federal rules and regulations governing information technology (IT) projects...


  • Austin, United States Infotree Global Solutions Full time

    **Responsibilities**: - Provide QA support on the floor for production - Ensure process control measures are in place and followed in product manufacturing - Receipt and disposition of incoming apheresis material. - Oversee and authorize shipment of final product - Verify and ensure timely issuance of production documents and labels - Review batch-related...


  • Austin, Texas, United States Allied Consultants, Inc. Full time

    Overview: Allied Consultants, Inc. is an Austin-based firm which has for 32 years been a premier provider of technical and business professionals to clients in Texas. We are currently seeking an experienced Technical Training Specialist to be a key resource on a technical services team.   Allied Consultants offers its family of consultants excellent...


  • Austin, United States PAR Full time

    Hi there! We're PAR and our purpose is: **To deliver solutions that connect people to the restaurants, meals and moments they love.** We take that responsibility very seriously. As a leading provider of technology to the top restaurant brands in the world we're calling all rebels, instigators, idealists and builders to join our constantly growing team! PAR...


  • Austin, United States Tata Consultancy Services Full time

    #LI-AS3 Technical/Functional Skills : •Specialist in Teamcenter PLM and Active Workspace (AWC) configuration and customization •Experience in Teamcenter 13.x, 14.x, 2312 and AWC 6.x implementation •Experience in ITK customization •Experience in configuring data model with BMIDE •Experience in working on CAD solution integration with Teamcenter...


  • Austin, United States Texas Department of Aging & Disability Services Full time

    Job Description: Program Specialist II Performs routine training, consultative services, technical assistance and analytical work. Duties include analyzing and remediating all types of electronic documents to eliminate accessibility and structural defects. Assists senior accessibility specialists with web testing assignments and the development of...


  • Austin, United States Health & Human Services Comm Full time

    Program Specialist II - Performs routine training, consultative services, technical assistance and analytical work. Duties include analyzing and remediating all types of electronic documents to eliminate accessibility and structural defects. Assists senior accessibility specialists with web testing assignments and the development of training materials and...