Sr. Technical Writer
Alianza, Inc. Pleasant Grove, Utah, United States
Software Development · 501-1,000 employees
About the role
The role involves planning, writing, and maintaining API reference documentation, developer guides, and integration tutorials for the Alianza Developer Portal. You will collaborate with engineering and product teams to ensure documentation accuracy while defining processes for consistency across the organization.
What they look for
Requirements
Candidates must have at least 7 years of technical writing experience, with a minimum of 3 years specifically focused on API or developer-facing documentation. Proficiency in REST API documentation, OpenAPI/Swagger standards, and the ability to navigate technical ambiguity are essential.
Full description
Sr. Technical Writer- API
Alianza is looking for an experienced API technical writer to partner with our Product, Engineering, and Support Business Engineering teams in building developer documentation for the Alianza Developer Portal and related API suites.
This position sits within Alianza’s existing technical writing team within the Support Business Engineering department. The role is distinct from current technical writing positions in its focus: while the broader team owns user-facing content, this role owns developer-facing content — the documentation, structure, and workflows that determine whether an experience provider can successfully integrate with Alianza’s APIs.
Responsibilities
- Plan, write, and maintain API reference documentation, developer guides, integration tutorials, and release notes.
- Evaluate and refine generated documentation output from OpenAPI spec pipelines, providing structured feedback on API quality and documentation completeness.
- Define API documentation processes and iterate existing workflows for consistency and efficiency across engineering and technical writing teams.
- Create and maintain an API documentation style guide covering terminology, structure, code samples, and error documentation.
- Collaborate with Engineering, Product, and other teams to gather technical information and ensure documentation accuracy.
- Review and edit existing documentation to improve clarity, accuracy, and consistency.
- Attend product demos and engineering meetings to stay current on API changes, new features, and deprecations.
- Gather feedback from the developer and experience provider community and iterate content accordingly.
- Work with other technical writers on content migrations and documentation tooling initiatives in Oxygen XML and Paligo.
- Deliver quality results in a fast-paced environment with a high degree of autonomy.
Required Qualifications
- 7+ years of experience authoring technical documentation, with at least 3 years focused on API or developer-facing documentation.
- Demonstrated experience writing REST API documentation, including API reference, authentication flows, error handling, and code samples.
- Familiarity with OpenAPI/Swagger standards and tools used for documenting APIs.
- Excellent written and verbal communication skills with a strong command of English grammar and technical style.
- Ability to navigate ambiguity, identify the right subject matter experts, and advocate for quality documentation across teams.
- Portfolio of developer-facing documentation including API reference, integration guides, tutorials, and/or style guidelines.
- Self-starter with the ability to manage multiple projects in a dynamic environment.
Preferred Qualifications
- Experience with developer portal platforms such as Kong Konnect, Redocly, or similar.
- Familiarity with Oxygen XML Author (DITA XML) and/or Paligo (cloud-based CCMS for DocBook XML).
- Experience with docs-as-code workflows, including Git and CI/CD pipelines.
- Knowledge of HTML, CSS, and Markdown for documentation formatting and portal customization.
- Experience in SaaS, telecom, or VoIP environments.
- Experience working on a global product with partners across multiple time zones.
- Familiarity with voice APIs, SIP, or real-time communications infrastructure.
- Strong interest in AI-assisted documentation tools and emerging developer experience standards.
Similar roles
-
Technical Writer
Bradken Coimbatore, Tamil Nadu, India
-
Technical Writer
Astrion Egg Harbor Township, New Jersey, United States
-
Senior Technical Writer
Honeywell North Branford, Connecticut, United States · $83K–$104K/yr
-
Problem Manager / Technical Writer
Govcio LLC Alexandria, Virginia, United States
-
Senior/Lead Technical Writer
Advanced Micro Devices, Inc Hyderabad, Telangana, India
-
Technical Writer, Senior
Booz Allen Hamilton Albuquerque, New Mexico, United States · $69K–$158K/yr