Product documentation isn’t just a technical requirement
While clear communication of technical product data between departments including engineering, manufacturing, and maintenance is critical to success, customer-facing teams like marketing and sales also need to visually communicate product value and information. The most effective way to visually represent products across all the required visual assets is by using real product data.
But the range of assets required, and the breadth and variety of teams and skills involved in creating and maintaining them, makes for a complicated picture.
Here we’ll look at five of the top-level documentation challenges product-based companies face every day, which can lead to inefficiency, errors and delays, missed opportunities, and even lost revenue.
challenge 1 – quantity
The sheer volume of product-based documentation in circulation at any given moment is a tough issue to manage. Different teams with different skill sets can be using different software to create different assets for different use cases, shared in different formats, all of which require maintenance and update on varying timeframes.
From manufacturing work instructions through to marketing product sheets, sales presentations, and maintenance manuals, all of these assets require high quality product visualization in order to do their job effectively. These variables create a complex matrix over which it is difficult for any team to have control.
- Multiple teams
- Different software and document formats
- Varied use cases
“If four customer facing people spend one hour each with four engineers getting a screenshot every week, that soon starts to create a lot of cost.”
challenge 2 – creation
Visualization of products is often the most effective way to communicate critical information, whether technical or promotional. But the process of creating visual assets can be problematic.
3D CAD product models are typically the best means of visualizing products, but access to those models is restricted to team members with specialized training and CAD software. The result is a bottleneck which must be navigated by downstream colleagues responsible for creating the broad variety of visual assets which support the product through its lifecycle. Having to request CAD screenshots from engineers delays content creators and diverts those high-cost engineers from their more important core tasks.
Meanwhile, working with a variety of software applications which have not been developed specifically to create product-based documentation, can further slow asset creation.
- Restricted access to real CAD models
- High-cost engineers diverted from core tasks
- Unsuitable software, hard to create call-outs, magnification
challenge 3 – quality
The need to create a large quantity of documents, usually on a tight time frame, coupled with the challenges faced in creating those documents, will often result in problems with the quality of critical documentation.
CAD screenshots or product photography, typically the means by which most downstream teams visualize products, show only one view of the product and perhaps might be compressed as part of the document creation process, further reducing the clarity they are able to provide.
And the inherent limitations of the software often used to create visual documents can have further negative affects on quality. The result is sub-standard communication, either failing to illustrate product value to maximum effect or – worse – leading to errors in product interaction or delays to critical purchasing decisions.
- Limited utility of screenshots
- Software limitations
- Ineffective communication
challenge 4 – consumption
Once visual documents have been created, the effectiveness of communication depends on how well and how quickly the audience is able to understand the content.
Here the limitations of screenshots and photography come into play once again. There is no guarantee that the consumer of a document will see everything they need to in a static image and PDF, Word, and PowerPoint documents offer no means by which the audience can interact with product content.
Moreover the audience may lack an easy, dedicated means by which they can offer feedback on the documents, and seek clarity and collaborate with the document creator.
- Static images show only one view
- No interactivity in flat documents
- Difficulty feeding back and collaborating
challenge 5 – obsolescence
In a manufacturing industry which is operating on ever shorter and faster product cycles, visual product documents can rapidly become outdated – particularly when they depend on static screenshots for illustration.
Hardware manufacture is evolving to become closer to software development, with agile processes and short sprints, thanks to developments including rapid prototyping, and additive manufacturing. Documentation must keep pace with product development and in modern manufacturing organizations, key documents can become obsolete in as little as a single working week.
And, even though a document might have a limited lifespan in terms of active usage, it must still be maintained in libraries and archives should it be required down the line.
- Manufacturing processes have accelerated
- Documentation needs to keep pace with product development
- Assets can become obsolete in as little as five days
solve your documentation challenges by empowering .everyone
Canvas Envision is the visual communication and collaboration platform which gives everyone in your organization the ability to quickly and easily create interactive visual documents which leverage real 3D CAD models.
- Single platform for the creation and consumption of all visual content
- Empowers everyone – including non-technical users – to embed interactive 3D CAD in any document.
- Smart tools including instant annotation, single-click call-outs, auto-trace
- Autonomous and optimized workflows reduces dependency on engineering teams saving time and expense
- Content can be consumed through any browser, audience able to interact with models to view individual parts, metadata, and view from all angles
- Real-time collaboration with mark-up and chat function
- Rapid updates and linked models removes stale data and reduces document maintenance