About The Position
About Port
The developer experience, developer productivity and driving software quality are on top of every engineering leader’s mind.
At Port, we help engineering organizations excel through the use of our open internal developer portal, owned by platform engineering teams and built for developers. Port consolidates everything developers need to know and execute to deliver software autonomously and to comply with organizational standards. Managers use Port to understand engineering metrics and improve them.
We’re growing rapidly, fueled by the industry’s leading product, and by the constant innovation of our customers, big and small, that use our product to change how developers work.
As a Technical Writer at Port, you’ll play a critical role in bridging our engineering and customer-facing teams by creating clear, accurate, and comprehensive documentation aimed mainly at platform engineers. Your work will directly impact customers who rely on our platform by empowering them to maximize their productivity and improve their workflows.
You’ll take part in the creation, maintenance, and evolution of Port’s documentation and knowledge base, shaping one of the first experiences users meet when they deploy and use the product.
What You’ll Do
- Document New Features and Updates: Partner with engineering and product teams to craft high-quality technical documentation for new and existing features. You’ll help translate complex technical information into clear, developer-friendly documentation.
- Add and Maintain API Documentation: Take part in maintaining the API documentation to ensure it’s comprehensive, up-to-date, and accessible, providing essential support for developers who integrate with our platform.
- Write Guides and Tutorials: Write tutorials, how-to guides, and user manuals that support developers in effectively leveraging Port’s capabilities.
- Write User-Centered Documentation: Work with other teams to gather insights directly from users and developers to understand their needs and pain points, ensuring that the documentation meets real-world use cases and aids in seamless onboarding and usage.
- Collaborate Across Teams: Work closely with product managers, designers, developers, and customer support to ensure the accuracy and quality of all documentation, while identifying opportunities to enhance clarity and usability.
- Communicate the Port brand: ensure consistency and accuracy across all product documentation.
Who You’ll Work With
As a technical writer, you will work closely with developers, product managers, and designers to ensure Port is accessible and user-friendly for customers worldwide.
You will also engage with customer support and sales teams to better understand user needs and incorporate their feedback.
Requirements
- 2+ years of experience as a Technical Writer in the software or tech industry, with experience documenting technical products.
- Strong technical proficiency and ability to understand and communicate complex engineering concepts, while adhering to Port’s writing style.
- Proficiency with Git and Markdown.
- Fluency in English.
- Experience with API documentation and tools like Swagger, Postman, or similar.
- Excellent collaboration skills, with the ability to work cross-functionally with engineering, product, and support teams.
Advantages
- Experience documenting complex systems in the realm of dev-tools.
- Experience writing and executing CI/CD workflows in one (or more) of the major providers (GitHub, GitLab, BitBucket, AzureDevops).
- Experience with the Docusaurus framework.
Familiarity/proficiency with React.
