Intermediate 6 topic areas 58+ exercises

Developer Portal Engineer

Developer Portal Engineers build and operate the internal platforms that give developers a single place to discover services, launch new projects, access documentation, and manage their service health. Working primarily with Backstage or similar tools, their daily English involves writing portal adoption proposals, onboarding teams to the service catalogue, documenting software templates, and presenting portal metrics to engineering leadership. This path covers the vocabulary of internal developer platforms and portal engineering.

Topics covered

  • Backstage & portal platforms
  • Service catalogue
  • Software templates
  • TechDocs & documentation
  • Plugins & integrations
  • Portal adoption metrics

Vocabulary spotlight

4 terms every Developer Portal Engineer should know in English:

service catalogue n.

A structured registry of all software components, APIs, libraries, and infrastructure resources in an organisation — providing discoverability and ownership information

"After populating the service catalogue, on-call engineers could find the owning team for any service in seconds instead of asking around Slack."
software template n.

A reusable scaffolding definition in a developer portal that generates a new project with standard configuration, CI/CD, and documentation — the golden path in code form

"The Node.js microservice template generates a complete repo with Dockerfile, GitHub Actions pipeline, and Backstage catalogue entry in under two minutes."
TechDocs n.

Backstage's docs-as-code documentation system that renders Markdown documentation stored alongside code — making docs discoverable through the portal

"We migrated all internal runbooks to TechDocs so they appear alongside the services they describe in the portal."
portal adoption n.

The proportion of teams or services actively using the developer portal — a key metric for measuring the portal's value and identifying gaps in coverage

"Portal adoption reached 80% after we made Backstage the authoritative source for on-call ownership information."
Open full glossary →

📚 Vocabulary Reference

Key terms organised by category for Developer Portal Engineers:

Portal Platform

developer portalBackstagePortOpsLevelCortexservice cataloguecomponentcatalogue entitycatalogue YAMLportal plugin

Scaffolding

software templatescaffoldergolden pathtemplate actiontemplate parametersskeletoncreate componentcatalog-info.yamlsystemdomain

Documentation

TechDocsdocs-as-codemkdocs.ymlMarkdown docsAPI specOpenAPI in portaldocumentation coveragerunbook linkADR registrychangelog

Metrics & Adoption

portal adoptioncatalogue coverageactive userstemplate usageonboarding timeself-service ratesupport ticket reductionsearch usagedeveloper NPSfeedback loop
Study full vocabulary modules →

Recommended exercises

Real-world scenarios you'll practise

  • Writing a Backstage adoption proposal: explaining the service catalogue value proposition to engineering leadership and presenting the rollout plan
  • Onboarding a team to the service catalogue: explaining how to register their component, write a catalogue YAML, and set up TechDocs
  • Writing a software template specification: documenting the inputs, generated output, and the standards the template enforces for a new microservice type
  • Presenting portal metrics to engineering leadership: active users, catalogue coverage, template usage rate, and time-to-first-deployment for new services

Recommended reading

Explore another role

✍️ Prompt Engineer

Open path →