On being a Documentation Engineer at Balena
As a Documentation Engineer at balena, you will lead the effort to educate the balenaCloud user base by creating world-class documentation and tutorials, enabling IoT developers to get the most out of the balena platform.
You will spend your days testing and learning all the ins and outs of deploying IoT fleets on balenaCloud, including new products, features and releases. You’ll document and describe all the technical capabilities of the platform in a clear, digestible format. In other words, you’ll become the world’s foremost expert on all things balena!
The documentation and internal knowledge base of solutions will be yours to design and maintain. You will create and organize this content, making sure it is synced, up-to-date, and easy for external and internal developers to quickly find the information they need.
You will be a critical element in balena’s [support driven development philosophy]( https://www.balena.io/blog/support-driven-development/ ), helping the support engineers be more efficient and accurate. You will be integral in recognizing knowledge gaps in our user base but also in our team.
You will work cross functionally with Engineering, Product Management and Sales. Think of yourself as an internal journalist, using the entire team as your source as you dig out the perfect descriptions of our solutions for customers and employees. You will be on the front line of accelerating the development of some of the coolest IoT and edge technology products in the world.This will be a full-time role.
RESPONSIBILITIES
Manage our docs from end to end. Document new features, maintain existing docs, organize the structure and flow of our docs, and ensure accuracy, clarity, and consistency across all of our internal and external technical documentation, including GitHub repos.
Work closely with the product, engineering, and customer success teams to understand technical details and their implications for users.
Measure our success in helping users understand the balena platform via our docs, share progress with the team, and find ways to continuously improve.
REQUIREMENTS
Need to have:
Excellent writing and communication skills. You turn complicated technical concepts into clear and interesting material.
Able to dive deep while keeping the big picture in mind. You can create lots of great content while seeing how it fits into our overall story and broader goals.
Able to work with developers and team members to gather technical details. Like a journalist, you aren’t afraid to ask questions to get to what’s most important for users to know, and root out knowledge gaps that will benefit customers.
Organized, thorough, accurate, and close attention to detail.
Self-motivated and able to set direction and priorities. You can be incredibly productive without much oversight and know where your time is best spent.
Skilled at learning and teaching new technical concepts. You don’t need to be a developer per se, but you do need to be able to build a thorough understanding of balena products and teach others about our technologies.
You believe positive user experiences are critical to success and love helping customers tackle technical problems
Able to understand the product from a user’s perspective and explain features in a way that users will appreciate.
Fluent in written and spoken English
Nice to have:
Experience working as a developer, particularly with JavaScript, HTML, and Linux
Experience building IoT and/or hardware projects. Bonus points if you’ve built something cool using balenaCloud
Familiarity with IoT, containers, electronics, or embedded software development.
Strong understanding of content and documentaion’s role in a SaaS developer platform.
Links to resources where we can see your work and projects you are proud of will be hugely beneficial.
BENEFITS
Work with an extremely talented, diverse team
Equipment of your choice
Remote-friendly
Flexible working hours
Flexible vacation policy
Annual company gathering in an international location
We send you hardware for side projects!
ABOUT WORKING AT BALENA
We come from 15+ countries, and we embrace a remote culture with flexible hours. To us, this means being highly productive while still maintaining a healthy work-life balance. You need to be able to work remotely, and have a dependable internet access available so you can join video calls.
We are an equal opportunity employer and value diverse backgrounds. We maintain a work environment in which team members are treated with respect at all times and in which thoughts and ideas can be shared openly.
We communicate proposals, discuss with others in the team and accept feedback if it makes the result better. We value the ability to learn, which is more important to us than knowledge of specific technologies. We know that learning fast means being outside our comfort zone, which is OK -- we'd rather grow than let our assumptions get in our way.
Sep 11, 2019
Full-time
On being a Documentation Engineer at Balena
As a Documentation Engineer at balena, you will lead the effort to educate the balenaCloud user base by creating world-class documentation and tutorials, enabling IoT developers to get the most out of the balena platform.
You will spend your days testing and learning all the ins and outs of deploying IoT fleets on balenaCloud, including new products, features and releases. You’ll document and describe all the technical capabilities of the platform in a clear, digestible format. In other words, you’ll become the world’s foremost expert on all things balena!
The documentation and internal knowledge base of solutions will be yours to design and maintain. You will create and organize this content, making sure it is synced, up-to-date, and easy for external and internal developers to quickly find the information they need.
You will be a critical element in balena’s [support driven development philosophy]( https://www.balena.io/blog/support-driven-development/ ), helping the support engineers be more efficient and accurate. You will be integral in recognizing knowledge gaps in our user base but also in our team.
You will work cross functionally with Engineering, Product Management and Sales. Think of yourself as an internal journalist, using the entire team as your source as you dig out the perfect descriptions of our solutions for customers and employees. You will be on the front line of accelerating the development of some of the coolest IoT and edge technology products in the world.This will be a full-time role.
RESPONSIBILITIES
Manage our docs from end to end. Document new features, maintain existing docs, organize the structure and flow of our docs, and ensure accuracy, clarity, and consistency across all of our internal and external technical documentation, including GitHub repos.
Work closely with the product, engineering, and customer success teams to understand technical details and their implications for users.
Measure our success in helping users understand the balena platform via our docs, share progress with the team, and find ways to continuously improve.
REQUIREMENTS
Need to have:
Excellent writing and communication skills. You turn complicated technical concepts into clear and interesting material.
Able to dive deep while keeping the big picture in mind. You can create lots of great content while seeing how it fits into our overall story and broader goals.
Able to work with developers and team members to gather technical details. Like a journalist, you aren’t afraid to ask questions to get to what’s most important for users to know, and root out knowledge gaps that will benefit customers.
Organized, thorough, accurate, and close attention to detail.
Self-motivated and able to set direction and priorities. You can be incredibly productive without much oversight and know where your time is best spent.
Skilled at learning and teaching new technical concepts. You don’t need to be a developer per se, but you do need to be able to build a thorough understanding of balena products and teach others about our technologies.
You believe positive user experiences are critical to success and love helping customers tackle technical problems
Able to understand the product from a user’s perspective and explain features in a way that users will appreciate.
Fluent in written and spoken English
Nice to have:
Experience working as a developer, particularly with JavaScript, HTML, and Linux
Experience building IoT and/or hardware projects. Bonus points if you’ve built something cool using balenaCloud
Familiarity with IoT, containers, electronics, or embedded software development.
Strong understanding of content and documentaion’s role in a SaaS developer platform.
Links to resources where we can see your work and projects you are proud of will be hugely beneficial.
BENEFITS
Work with an extremely talented, diverse team
Equipment of your choice
Remote-friendly
Flexible working hours
Flexible vacation policy
Annual company gathering in an international location
We send you hardware for side projects!
ABOUT WORKING AT BALENA
We come from 15+ countries, and we embrace a remote culture with flexible hours. To us, this means being highly productive while still maintaining a healthy work-life balance. You need to be able to work remotely, and have a dependable internet access available so you can join video calls.
We are an equal opportunity employer and value diverse backgrounds. We maintain a work environment in which team members are treated with respect at all times and in which thoughts and ideas can be shared openly.
We communicate proposals, discuss with others in the team and accept feedback if it makes the result better. We value the ability to learn, which is more important to us than knowledge of specific technologies. We know that learning fast means being outside our comfort zone, which is OK -- we'd rather grow than let our assumptions get in our way.
At GitLab, our team of technical writers is responsible for ensuring that the documentation for all of our products is clear, correct, comprehensive, and easy to use. We are looking for great writers with strong technical proficiencies who will help our users succeed with our rapidly evolving suite of DevOps tools .
As part of our growing team, you’ll collaborate with GitLab engineers, who typically write the first draft of docs for the new features they create. You’ll dive in on special projects, planning and authoring new content and helping craft new doc site features and processes. You’ll collaborate with others across the organization to craft tutorials and other educational resources. You’ll be at the leading edge of DevOps while contributing to one of the world’s largest open-source projects and engaging with our wider community.
GitLab is an all-remote company and this is a remote position with no geographical requirements.
Responsibilities
Continuously improve GitLab’s documentation content in collaboration with engineers, product managers, and others.
Review and edit doc plans and content for all new and enhanced features.
Through the use and testing of GitLab and its documentation, as well as SME interviews, proactively identify information needs and content opportunities. Develop new content to meet those needs and plan further work for the technical writing team.
Plan and complete large content initiatives such as section reviews and overhauls.
Help developers and other members of the community who have documentation-related questions.
Help review and triage incoming suggestions, corrections, and other content from the community.
Act as a primary content reviewer for other technical writers.
Continuously improve GitLab’s documentation site features and user experience in collaboration with engineers and other technical writers. This may include the documentation site’s design, search, build process, feedback methods, SEO, visitor analytics, versioning, and other technical components.
Plan and lead documentation site feature enhancement initiatives.
Work with UX to identify contextual content/documentation opportunities in the product.
Produce reports on documentation usage and metadata.
Contribute to the improvement of team process and style, as well as cross-functional efforts.
Act as a reviewer of release blog posts and contributor to GitLab’s Handbook .
Make it easy for contributors from the community—internal and external—to submit quality documentation.
Contribute to the documentation Style Guide and documentation process guides .
Collaborate and improve upon collaborative processes with others including product managers, Support, Marketing, Engineering, and the wider GitLab community.
Leadership and collaboration
Mentor newly hired technical writers.
Lead projects when pairing with other technical writers.
Plan new cross-functional efforts.
Represent the team at hackathons or other community endeavors.
Plan and lead a portion of the team’s process-improvement initiatives.
Organize and prioritize portions of the team's work backlogs.
Requirements
You have:
Extensive experience planning, writing, and managing software documentation.
Excellent skills in writing, editing, research, and planning.
Understanding of what makes documentation clear and effective.
Great teaching skills that translate into amazing written work.
Experience establishing processes used by teams across an organization in support of documentation.
Experience planning and leading major initiatives such as the launch of new documentation resources, large-scale documentation reviews and overhauls, cross-functional initiatives, etc.
Experience using data and evidenced-based decision making.
Experience using Git on the Linux or Mac command line and developer tools and workflows.
Experience with a docs-as-code workflow, a markup language such as Markdown, AsciiDoc, or reStructuredText, and at least one programming language (though this does not need to be from a professional context).
Experience with some of the following:a
Using or documenting DevOps tools; especially deep experience with one or more GitLab DevOps Stage Groups .
Developing sites using static site generators.
JavaScript and intermediate front-end development.
Advanced programming or other technical experience.
Using GitLab.
A rapidly scaling start-up environment.
Remote work; especially in collaboration with others across countries and time zones.
You are:
Highly organized; able to triage and prioritize numerous issues and projects.
Able to succeed in a remote , globally distributed work environment.
You share our values , and work in accordance with those values.
Sep 01, 2019
Full-time
At GitLab, our team of technical writers is responsible for ensuring that the documentation for all of our products is clear, correct, comprehensive, and easy to use. We are looking for great writers with strong technical proficiencies who will help our users succeed with our rapidly evolving suite of DevOps tools .
As part of our growing team, you’ll collaborate with GitLab engineers, who typically write the first draft of docs for the new features they create. You’ll dive in on special projects, planning and authoring new content and helping craft new doc site features and processes. You’ll collaborate with others across the organization to craft tutorials and other educational resources. You’ll be at the leading edge of DevOps while contributing to one of the world’s largest open-source projects and engaging with our wider community.
GitLab is an all-remote company and this is a remote position with no geographical requirements.
Responsibilities
Continuously improve GitLab’s documentation content in collaboration with engineers, product managers, and others.
Review and edit doc plans and content for all new and enhanced features.
Through the use and testing of GitLab and its documentation, as well as SME interviews, proactively identify information needs and content opportunities. Develop new content to meet those needs and plan further work for the technical writing team.
Plan and complete large content initiatives such as section reviews and overhauls.
Help developers and other members of the community who have documentation-related questions.
Help review and triage incoming suggestions, corrections, and other content from the community.
Act as a primary content reviewer for other technical writers.
Continuously improve GitLab’s documentation site features and user experience in collaboration with engineers and other technical writers. This may include the documentation site’s design, search, build process, feedback methods, SEO, visitor analytics, versioning, and other technical components.
Plan and lead documentation site feature enhancement initiatives.
Work with UX to identify contextual content/documentation opportunities in the product.
Produce reports on documentation usage and metadata.
Contribute to the improvement of team process and style, as well as cross-functional efforts.
Act as a reviewer of release blog posts and contributor to GitLab’s Handbook .
Make it easy for contributors from the community—internal and external—to submit quality documentation.
Contribute to the documentation Style Guide and documentation process guides .
Collaborate and improve upon collaborative processes with others including product managers, Support, Marketing, Engineering, and the wider GitLab community.
Leadership and collaboration
Mentor newly hired technical writers.
Lead projects when pairing with other technical writers.
Plan new cross-functional efforts.
Represent the team at hackathons or other community endeavors.
Plan and lead a portion of the team’s process-improvement initiatives.
Organize and prioritize portions of the team's work backlogs.
Requirements
You have:
Extensive experience planning, writing, and managing software documentation.
Excellent skills in writing, editing, research, and planning.
Understanding of what makes documentation clear and effective.
Great teaching skills that translate into amazing written work.
Experience establishing processes used by teams across an organization in support of documentation.
Experience planning and leading major initiatives such as the launch of new documentation resources, large-scale documentation reviews and overhauls, cross-functional initiatives, etc.
Experience using data and evidenced-based decision making.
Experience using Git on the Linux or Mac command line and developer tools and workflows.
Experience with a docs-as-code workflow, a markup language such as Markdown, AsciiDoc, or reStructuredText, and at least one programming language (though this does not need to be from a professional context).
Experience with some of the following:a
Using or documenting DevOps tools; especially deep experience with one or more GitLab DevOps Stage Groups .
Developing sites using static site generators.
JavaScript and intermediate front-end development.
Advanced programming or other technical experience.
Using GitLab.
A rapidly scaling start-up environment.
Remote work; especially in collaboration with others across countries and time zones.
You are:
Highly organized; able to triage and prioritize numerous issues and projects.
Able to succeed in a remote , globally distributed work environment.
You share our values , and work in accordance with those values.
At GitLab, our team of technical writers is responsible for ensuring that the documentation for all of our products is clear, correct, comprehensive, and easy to use. We are looking for great writers with strong technical proficiencies who will help our users succeed with our rapidly evolving suite of DevOps tools .
As part of our growing team, you’ll collaborate with GitLab engineers, who typically write the first draft of docs for the new features they create. You’ll dive in on special projects, planning and authoring new content and helping craft new doc site features and processes. You’ll collaborate with others across the organization to craft tutorials and other educational resources. You’ll be at the leading edge of DevOps while contributing to one of the world’s largest open-source projects and engaging with our wider community.
GitLab is an all-remote company and this is a remote position with no geographical requirements.
Responsibilities
Continuously improve GitLab’s documentation content in collaboration with engineers, product managers, and others.
Review and edit doc plans and content for all new and enhanced features.
Produce written guides for using GitLab features.
Help developers and other members of the community who have documentation-related questions.
Identify and address content gaps or the need for additional media such as diagrams or videos.
Participate in reviews and revamps of section or page content and structure.
Help review and triage incoming suggestions, corrections, and other content from the GitLab community.
Continuously improve GitLab’s documentation site features and user experience in collaboration with engineers and other technical writers. This may include the documentation site’s design, search, build process, feedback methods, SEO, visitor analytics, versioning, and other technical components.
Contribute to the planning and creation of new site features and enhancements.
Coordinate with frontend and backend engineers when their help is needed.
Contribute to the improvement of team process and style, as well as cross-functional efforts.
Act as a reviewer of release blog posts and contributor to GitLab’s Handbook .
Make it easier for contributors from the community—internal and external—to submit quality documentation.
Contribute to the documentation Style Guide and documentation process guides .
Collaborate with and help improve upon collaborative processes with others including product managers, Support, Marketing, Engineering, and the wider GitLab community.
Requirements
You have:
Experience writing and managing software documentation.
Excellent skills in writing, editing, research, and planning.
Understanding of what makes documentation clear and effective.
Great teaching skills that translate into amazing written work.
Experience using the Linux shell, command-line Git, HTML/CSS, and at least one programming language (does not have to be from a professional context),
Experience using static site generators and managing docs as code.
Experience with some of the following:
Using or documenting DevOps tools; especially deep experience with one or more GitLab DevOps Stage Groups .
JavaScript and intermediate front-end development.
Advanced programming or other technical experience.
Using GitLab.
A rapidly scaling start-up environment.
Remote work; especially in collaboration with others across countries and time zones.
You are:
Highly organized; able to triage and prioritize numerous issues and projects.
Able to succeed in a remote, globally distributed work environment.
You share our values , and work in accordance with those values.
Successful candidates will also be likely to bring experience with some of the following:
Using or documenting DevOps tools; especially deep experience with one or more GitLab DevOps Stage Groups
JavaScript and intermediate front-end development
Advanced programming or other technical experience
Using GitLab
A rapidly scaling start-up environment
Remote work; especially collaboration across borders and time zones
Sep 01, 2019
Full-time
At GitLab, our team of technical writers is responsible for ensuring that the documentation for all of our products is clear, correct, comprehensive, and easy to use. We are looking for great writers with strong technical proficiencies who will help our users succeed with our rapidly evolving suite of DevOps tools .
As part of our growing team, you’ll collaborate with GitLab engineers, who typically write the first draft of docs for the new features they create. You’ll dive in on special projects, planning and authoring new content and helping craft new doc site features and processes. You’ll collaborate with others across the organization to craft tutorials and other educational resources. You’ll be at the leading edge of DevOps while contributing to one of the world’s largest open-source projects and engaging with our wider community.
GitLab is an all-remote company and this is a remote position with no geographical requirements.
Responsibilities
Continuously improve GitLab’s documentation content in collaboration with engineers, product managers, and others.
Review and edit doc plans and content for all new and enhanced features.
Produce written guides for using GitLab features.
Help developers and other members of the community who have documentation-related questions.
Identify and address content gaps or the need for additional media such as diagrams or videos.
Participate in reviews and revamps of section or page content and structure.
Help review and triage incoming suggestions, corrections, and other content from the GitLab community.
Continuously improve GitLab’s documentation site features and user experience in collaboration with engineers and other technical writers. This may include the documentation site’s design, search, build process, feedback methods, SEO, visitor analytics, versioning, and other technical components.
Contribute to the planning and creation of new site features and enhancements.
Coordinate with frontend and backend engineers when their help is needed.
Contribute to the improvement of team process and style, as well as cross-functional efforts.
Act as a reviewer of release blog posts and contributor to GitLab’s Handbook .
Make it easier for contributors from the community—internal and external—to submit quality documentation.
Contribute to the documentation Style Guide and documentation process guides .
Collaborate with and help improve upon collaborative processes with others including product managers, Support, Marketing, Engineering, and the wider GitLab community.
Requirements
You have:
Experience writing and managing software documentation.
Excellent skills in writing, editing, research, and planning.
Understanding of what makes documentation clear and effective.
Great teaching skills that translate into amazing written work.
Experience using the Linux shell, command-line Git, HTML/CSS, and at least one programming language (does not have to be from a professional context),
Experience using static site generators and managing docs as code.
Experience with some of the following:
Using or documenting DevOps tools; especially deep experience with one or more GitLab DevOps Stage Groups .
JavaScript and intermediate front-end development.
Advanced programming or other technical experience.
Using GitLab.
A rapidly scaling start-up environment.
Remote work; especially in collaboration with others across countries and time zones.
You are:
Highly organized; able to triage and prioritize numerous issues and projects.
Able to succeed in a remote, globally distributed work environment.
You share our values , and work in accordance with those values.
Successful candidates will also be likely to bring experience with some of the following:
Using or documenting DevOps tools; especially deep experience with one or more GitLab DevOps Stage Groups
JavaScript and intermediate front-end development
Advanced programming or other technical experience
Using GitLab
A rapidly scaling start-up environment
Remote work; especially collaboration across borders and time zones
