Developer Documentation Engineer

Project

Work done for a product or program.

• Write and maintain software reference manuals, API references, integration guides and getting-started tutorials.
• Extract and structure API documentation from source comments using Doxygen and Sphinx toolchains.
• Develop end-to-end tutorials that are executed and verified on real hardware before publication.
• Maintain documentation as code in the same repositories and review cycles as the software it describes.
• Build and operate docs-as-code publishing pipelines with versioning aligned to SDK and BSP releases.
• Interview engineers and read source code to document undocumented behaviour, constraints and errata.
• Track documentation gaps from support tickets, forum questions and customer feedback and close them systematically.
• Enforce terminology consistency, style guides and translation readiness across the documentation set.
• Document migration paths, breaking changes and deprecations for every release.
• Measure documentation effectiveness through search analytics, page feedback and support ticket deflection.

Function

Work that keeps the discipline running: methods, tools, suppliers and people.

• Maintain the policies, processes and tools of the function.General
• Keep the function compliant with legal, financial and regulatory requirements.General
• Report the function's performance and improve it over time.General

Project

1. Produce and hand over the role's key deliverables
   • Software reference manuals and API reference sites
   • Getting-started guides and verified tutorials
   • Release-aligned documentation versions and migration notes
   • Documentation style guide and terminology glossary
   • Docs-as-code publishing pipeline
   • Documentation gap analysis and coverage reports
2. Support programsGeneral
   • Agree what each program needs
   • Deliver in time for milestones
3. Manage issuesGeneral
   • Track requests to closure
   • Escalate risks

Function

1. Run the functionGeneral
   • Maintain policies and processes
   • Keep records and controls
2. ImproveGeneral
   • Report performance
   • Lead improvement work