Documentation IT Engineer
Spinnaker Algo Systems · Lisboa
Sobre a função
Role Overview
We are looking for a Documentation Engineer to unify, structure, and publish the technical documentation for our products, including APIs, service integrations, data models, and multi-tenant operations.
This role is essential in transforming dispersed specifications, internal knowledge, and development team insights into reliable, structured, and continuously maintained documentation.
The complexity of the role lies not in syntax, but in understanding business rules, integration logic, system contracts, and the interaction between multiple interconnected products.
Mission
The Documentation Engineer will be responsible for building and maintaining a high-quality documentation framework that supports developers, product teams, operations, partners, and clients. This includes creating clear architecture guides, integration documentation, onboarding materials, runbooks, API references, and release-based documentation pipelines.
Key Responsibilities
Produce and maintain architecture guides, integration guides, onboarding documentation, and operational runbooks.
Structure, improve, and maintain the documentation portal using a docs-as-code approach.
Automate documentation generation from OpenAPI specifications, schemas, and other relevant sources where applicable.
Document and maintain integration contracts, including APIs, events, and data models.
Implement CI/CD documentation pipelines with validation and publication by release.
Ensure that documentation is required for new endpoints, events, and public integration contracts.
Actively extract knowledge from development, product, and operations teams.
Define and manage the documentation publication model, including internal documentation, external documentation, and documentation by feature or module.
Standardise documentation formats, terminology, and ownership across products and teams.
Ensure documentation remains accurate, versioned, searchable, and aligned with product releases.
Required Experience and Skills
3–5+ years of experience in technical documentation for B2B, SaaS, platform, or technology products.
Strong understanding of REST APIs and distributed backend systems.
Comfortable working with event-driven architecture and contract-based documentation.
Experience with Git, Markdown, static documentation portals, and CI/CD processes for documentation.
Ability to read technical specifications, diagrams, schemas, and code without needing to develop product features.
Strong ability to translate complex technical concepts into clear, structured, and usable documentation.
Fluent technical English, written and spoken.
Fluent Portuguese, written and spoken.
Strong communication skills and ability to work closely with engineering, product, and operations teams.
Nice to Have
Experience with OpenAPI, AsyncAPI, or messaging documentation.
Experience documenting event-driven systems, message queues, or asynchronous workflows.
Familiarity with ADRs, C4 diagrams, Mermaid diagrams, and domain glossaries.
Experience in multi-tenant, multi-service, or distributed platform environments.
Experience defining documentation governance, review processes, and release-based documentation standards.
Reporting Line
The Documentation Engineer will work closely with the development team, product team, and technical leadership, reporting directly to the Head of Development or Engineering Lead.
Success Criteria
Success in this role will be measured by the ability to create a reliable, structured, and scalable documentation system that reduces dependency on tacit knowledge, improves onboarding, supports integrations, and ensures that documentation evolves consistently with each product release.
Apply to recruiting@spinnakeralgo.com