Optimising API & SDK documentation to drive global adoption for Wacom end users

Introduction

Transforming complex SDK content into clear, user-friendly resources

Wacom is a leader in tablet computing and the top producer of graphics hardware for designers, artists, and engineers. Wacom offer external developers access to their software through the Wacom Ink Layer Language (WILL) API.

Wacom aims to make WILL a standard for onscreen graphics in the same way as HTML is the norm for web development. To enable widespread adoption, Wacom needed to provide easy-to-use, clear, and concise Software Development Kit (SDK) documentation.

This required a significant content update and Altuent was engaged to address the issue and execute a plan of action.

The challenge

Overhauling API documentation for the WILL SDK

While the talented developers in Wacom had created their own SDK documentation, a lack of technical writing expertise led to the following issues:

• Original SDK content was created in Japanese, with subsequent versions translated by non-native English speakers.
• Key information for new users was not highlighted.
• Effective knowledge-sharing techniques were not implemented.
• Links between tutorials and API reference material were not emphasised.
• Some content required an improved structure and formatting in order to enhance user understanding.
  

Recognising these problems, Wacom sought a partner with a proven track record in producing clear, concise API documentation. They needed a trusted team to handle technical content with minimal input, delivering timely improvements across the document landscape, from high-level concept articles through to API documentation and tutorials.

Our approach

Maximising functionality for end users

Altuent information architects and technical writers worked with the software developers in Wacom to enhance their WILL SDK documentation through our Managed Services.

The steps we took as part of our process:

1. Analyse deliverables and review Wacom’s existing documentation.
2. Recommend potential improvements.
3. Prioritise proposed improvements and agree on content updates while working to Wacom’s timeline.
4. Improved high-concept articles’ structure and organisation aligning to Wacom content management procedures and systems..
5. Expand Wacom’s tutorials to fully support novices while facilitating quick understanding and adoption by experienced users.
6. Implement comprehensive linking between these tutorials and related Wacom API reference topics.
7. Develop new information structures for Wacom to protect their content against obsolete or broken links.

Additional key actions included proposing effective solutions to bridge information gaps, silos, and updating metadata effectively. As a result, this consistency supports and drives increased trust in the Wacom brand strategy and reputation.

The results

Improving external adoption of the WILL API with clear and efficient SDK documentation

Our experts identified and rectified inconsistencies inconsistencies, enhancing the API content and improving Wacom’s brand perception. Detailed status reports and updated timelines enabled the organisation to better control review schedules, reducing waiting times and speeding up content production.

This exercise led to increased global adoption of the WILL API, thanks to high-quality, structured SDK documentation and user-friendly tutorials. Developers were impressed with our technical knowledge and autonomy, proving the value of a flexible partner with exceptional expertise. Following our success in the first phase, Wacom expanded the project to deliver even more optimised content tailored to the business and its users.