About The Position

Build a documentation generator that produces consistent artifacts from existing engineering sources Prototype and implement auto-generated system views such as: - System/block diagrams derived from interface inputs/outputs and component relationships - A static HTML documentation site that lets engineers browse the latest interfaces and related metadata Create a repeatable pipeline for generating documentation (e.g., runnable locally and/or in CI) with clear instructions for use and contribution Integrate navigation and “traceability-style” links where feasible (for example, linking interface documentation to related Jira/Jama items or other references) Build verification/auditing utilities that detect inconsistencies in design artifacts and documentation Talk with systems engineers to understand how they search for system info today, then adjust the tooling to match how they work Document your work clearly: how the tool works, how to run it, how to extend it, and what conventions teams should follow going forward Present a demo and recommended next steps at the end of the program

Requirements

  • Currently pursuing a BS or MS in Computer Science, Software Engineering, Computer Engineering, Data Science, or similar
  • Comfort writing code in at least one general-purpose language used for tooling (e.g., Python, TypeScript/JavaScript, or similar)
  • Experience with Git and GitHub workflows (branches, pull requests, code reviews)
  • Interest in developer tooling, automation, documentation systems, and/or data visualization
  • Ability to take an ambiguous problem, propose a plan, and iterate independently while communicating progress and risks
  • Clear written communication skills—your output will be used by engineers who were not involved in building the tool
  • Familiarity with static site generation concepts (Markdown pipelines, docs-as-code, search indexing, etc.)
  • Experience parsing and transforming structured text formats (JSON/YAML/XML/IDLs), building CLIs, or writing code generators

Nice To Haves

  • Familiarity with UML/PlantUML, diagram generation, Graphviz, or similar
  • Exposure to requirements or work-tracking tools (Jama, Jira) and/or “traceability” concepts
  • Interest in human-centered design for engineering tools: usability, information architecture, and adoption

Responsibilities

  • Build a documentation generator that produces consistent artifacts from existing engineering sources
  • Prototype and implement auto-generated system views such as system/block diagrams and static HTML documentation site
  • Create a repeatable pipeline for generating documentation
  • Integrate navigation and traceability links
  • Build verification/auditing utilities
  • Talk with systems engineers to understand how they search for system info
  • Document your work clearly
  • Present a demo and recommended next steps at the end of the program
© 2024 Teal Labs, Inc
Privacy PolicyTerms of Service