Technical Author
3 days ago
As a technical author, you'll be part of an engineering team, focused on a specific Canonical product.
You will lead the team effort to create, maintain and improve documentation that serves the needs of the product's users, embracing the principles of the Diátaxis documentation framework. You will have a broad impact on - and responsibility for - the quality of the user experience with the product, and will contribute towards the long-term success of the project itself.
As the technical author on the team, you will collaborate with software developers, product managers, community members, other documentation authors, information architects, quality assurance engineers and technical support engineers to develop clear documentation for complex technical topics.
You will have an important role in a company-wide effort to establish excellence in documentation, across all aspects of its practice.
**What you'll do**:
- Create, maintain and improve tutorials, how-to guides, reference guides and explanatory material
- Address the needs of users including developers, system administrators and end-users
- Use and explore the product in depth, to help discover where the documentation needs to be improved
- Review, road-test and improve practical guides
- Update reference and explanation material in collaboration with colleagues
- Improve and correct documentation based on feedback from users and technical support
- Read design documents and specifications
- Build, install, and use pre-release software to assist in generating proper instructions
- Standardise the structure, presentation, style and language of content across products
- Actively improve documentation, through attention to practice, process, tools and users' needs
- Contribute towards the development of documentation as a professional discipline at Canonical
- Is a technical author who's comfortable working with, reading and writing code, or a programmer/developer with a record of producing excellent documentation
- Has software development experience in Python, JavaScript or other suitable languages
- Is qualified with a BS/BA or equivalent in Technical Communication, English, or Computer Science
- Is experienced working in a technical writing position
- Has excellent written and verbal communication skills
- Has the ability to assimilate technical information rapidly from a variety of sources
- Has the character and flexibility to work in a fast-paced environment
- Is familiar with command line UNIX/Linux
- Is effective working in a distributed team
- Is confident using Ubuntu Desktop for all of the above
- Is familiar with Git or other version control systems
- Has knowledge of HTML and Markdown
- Is able to travel twice a year for up to two weeks for events
Canonical is a growing international software company that works with the open-source community to deliver Ubuntu, the world's best free software platform. Our services help businesses worldwide reduce costs, improve efficiency and enhance security with Ubuntu.
stack
LI-remote
-
Technical Author
1 week ago
Edinburgh, United Kingdom Dayshape Full time**About Dayshape** We’re Dayshape - an award-winning enterprise software scale-up with big ambitions and the momentum to match. Trusted by Big Four and many other top professional services firms globally, our AI-powered resource management platform is helping organizations to achieve extraordinary results. Our platform stands apart as the only solution...
-
Technical Author
3 days ago
Edinburgh, United Kingdom Cyberhawk Full time**Remote or Hybrid (Edinburgh HQ)** Cyberhawk are looking for a Technical Author who wants to make a big impact, have autonomy and responsibility in a flexible company who value their employees. We use drones and software to keep people out of danger and reduce the carbon footprint of our energy and large capital project clients. **The day-to-day** -...
-
Senior Technical Author
5 days ago
Edinburgh, United Kingdom Craneware Full time**Company** - Craneware PLC **Speciality** - Technology **Category** - Permanent **Location Country** **Office Location** - Edinburgh **Additional Locations** **Introduction to Craneware** - Let’s transform the business of healthcare! At The Craneware Group, we are dedicated to empowering our customers with industry-defining insights that pave the...
-
Three - Customer Technical Authority
5 days ago
Edinburgh, Edinburgh, United Kingdom Vodafone Full time £60,000 - £120,000 per yearLocation: Hybrid + Customer SiteSalary: Excellent basic salary plus bonus and Vodafone benefitsWorking Hours: Full time 37.5 hours per week – Mon to FriHybridWe believe that through collaboration and connection with our colleagues we can achieve great things. Our hybrid working approach allows our people to work both in the office and at home, providing...
-
Edinburgh, United Kingdom Vodafone Full time**Location**: Hybrid + Customer Site **Salary**: Excellent basic salary plus bonus and Vodafone benefits **Working Hours**:Full time 37.5 hours per week - Mon to Fri- - **Hybrid**- - We believe that through collaboration and connection with our colleagues we can achieve great things. Our hybrid working approach allows our people to work both in the office...
-
Installation Design Authority
5 days ago
Edinburgh, United Kingdom Fujitsu Full time**Installation Design Authority** **Location - Edinburgh** **Yellow** Are you a competent design authority on smaller/medium scale solutions ? Can you design and deliver smaller/medium architectures, strategies and specific solutions and oversee the work of others ? Do you want to shape your world and change the way the world works? Do you want to...
-
Technical Author
3 days ago
Edinburgh, United Kingdom N-able Full timeWhy N-able: IT doesn’t get better than this! N-able isn’t just another software company - we’re going places, and we’d love for you to be a part of that journey. With N-ablites in more than 15 countries around the world, you’re adding your unique voice to a diverse team of people who are supporting our customers, and one another. The Way We Work,...
-
Technical Writer
1 week ago
Edinburgh, United Kingdom Corero Full time**Technical Writer - Part-time** **About us** **The role** **Responsibilities**: - Produce high-quality, easy to use documentation appropriate for the intended audience in the form of release notes, user guides, online help and other forms of content, on schedule and to high quality. - Work closely with engineering, QA, product management and customer...
-
Technical Writer
7 days ago
Edinburgh, United Kingdom Cyberhawk Full time**Remote or Hybrid (Edinburgh HQ)** Cyberhawk are looking for a Technical Writer / Author who wants to make a big impact, have autonomy and responsibility in a flexible company who value their employees. We use drones and software to keep people out of danger and reduce the carbon footprint of our energy and large capital project clients. **The...
-
Technical Director
4 weeks ago
Edinburgh, United Kingdom Exergy3 Limited Full timeWhat Exergy3 does: Exergy3 is a dynamic and forward-thinking company committed to delivering cost effective decarbonisation of industrial processes through exceptional high-temperature thermal energy storage solutions. We’re at a pivotal stage in our evolution, delivering our first pilot projects, growing our team, and commercialising our...