PRODUCT DOCUMENTATION

Intel

Augmented support for the internet of things.

Introduction

How we helped Intel augment the services provided by full-time team members. 

Intel’s Internet of Things Group (IOTG) Technical Communications team required contract information developers to augment the services provided by full-time team members. As this was to meet the needs of rapid expansion, our team had to integrate seamlessly and engage effectively with the task at hand.

TWi_quotes-pink

TWi quickly mastered our tools and processes and interacted well with the engineering and architecture teams ... we were more than happy.

Courney Rothman-Ivy, IOTG Technical
Publications Manager, Intel Corporation

Intel: Augmented support for the Internet of Things

Intel is known as a leading manufacturer and developer of computer microprocessors and chipsets. Today, however, it is so much more. Intel designs and develops solutions for cloud applications, the Internet of Things (IoT), the latest advances in memory, programmable solutions, and always-on 5G connectivity. TWi has worked with several divisions within Intel, assisting platform architects and engineers in the preparation and publishing of customer-facing product documentation.

 

THE CHALLENGE: AUGMENT THE WORLDWIDE INTEL TEAM WITH CONTENT EXPERTISE

Intel’s Internet of Things Group (IOTG) Technical Communications team required contract information developers to augment the services provided by full-time team members. As this was to meet the needs of rapid expansion, our team had to integrate seamlessly and engage effectively with the task at hand.

The IOTG Technical Communications team provides information development services to engineers and software developers who work with customer-facing product documentation. Intel needed information developers who could interact directly with engineers worldwide and help them to develop product documentation. The content had to be developed in accordance with Intel’s documentation standards and guidelines. Our team reported directly to the IOTG Technical Communications team manager.

 

THE ACTION: EMBED DEDICATED WRITERS WITHIN INTEL

Our information developers supported two divisions encompassing the IOTG Technical Communications team and various other Intel engineering teams. The TWi contingent was onsite whenever the client needed them to be, which worked out as roughly one day a week as the project progressed. At other times, they worked from the TWi office or from their home offices. The IOTG Technical Communications team provided resources including templates, style guides, and processes that enabled our crew to support the local engineering teams.

While they were “on loan” to Intel, our writers added to the client’s team by:

      • Planning We gauged and determined the scope of the required product documentation
      • Draft preparation We wrote, formatted, edited, and created graphics for the IOTG team
      • Documentation review Our team initiated and managed shared PDF reviews and formal content reviews
      • Documentation updates We supported the update process in a way that freed up valuable time for Intel engineers, adding value and ensuring that the right skills were deployed in the right areas
      • Publishing We ensured that the content was available at the appropriate portal for customer access while working with Intel’s document classification system
      • Managing customer access to documentation This function involved close coordination with the engineers who managed customer relationships

THE IMPACT: INSTANT EXPERTISE AND INNOVATIVE CONTENT SOLUTIONS

Our core impacts for the client included:

      • Improved documentation quality and conformance to Intel standards
      • An augmentation solution for the IOTG Technical Publications Group
      • Local support with a single point of contact for documentation-related questions
      • Freeing up valuable engineering time by:
        • Implementing formatting and ensuring conformance
        • Managing conformance to Intel branding guidelines
        • Incorporating comments from documentation reviews
        • Managing the publishing and customer access processes
      • Improved product documentation organization on access portals

Feedback from Intel’s engineers and software developers was extremely positive, lauding the convenience of having a go-to person to provide help and support on all matters related to the development of product documentation. The Intel team recognized the improved level of quality brought by TWi and appreciated the effort we put in to ensure that our work was consistently exemplary.

They also appreciated the new ideas that were introduced by our team, such as the Collateral Update Bulletin that provided a system for keeping track of new or updated product documentation information. They particularly praised the clear, structured organisation of the content and the indicator system we developed to highlight recent updates. We used Visual Basic for Applications (VBA) scripts to efficiently extract and format information from technical publication databases. The bulletin could be produced in a matter of hours.

Our information developers consistently met or exceeded Intel’s quality expectations. The client tracked various content parameters with a customized analytical tool that was introduced to improve quality. Our team regularly outperformed expectations and requirements by achieving scores of 80 or more.

 

THE CLIENT’S PERSPECTIVE:

“TWi provided excellent support at a time when hiring full-time staff was restricted. They quickly mastered our tools and processes and interacted well with the engineering and architecture teams we support. TWi provided exactly the type of independent, self-motivated resources we needed to support our development teams in Ireland and internationally. We were more than happy with the support they provided while on contract for Intel.”

– Cortney Rothman-Ivy, IOTG Technical Publications Manager, Intel Corporation

Related Insights

Interdisciplinary Synergy in Technical Communication

Interdisciplinary Synergy in Technical Communication: Written by Neil Mahony and originally published in the Winter 2023 edition of the Communicator Magazine. Across all industries, companies struggle with the drawbacks of siloed departments. They create change...

Mastering Content Migration Strategy: A step-by-step guide to success

A content migration involves multiple moving parts, and navigating the entire process from start to finish can seem overwhelming. However, with a well-defined content migration strategy and a clear understanding of the necessary steps, you can effectively manage the...

SAP Enable Now Webinar Videos

As you know, we recently hosted a webinar in collaboration with SAP focused on how to get the most out of your SAP Enable Now investment, and we have compiled a playlist of six short snippets from our webinar. In this webinar, we share a getting-started approach that...

Accidence Happen: Review of a Non-Pedantic Guide to Language Change

Oliver Kamm’s Accidence Will Happen: The Non-Pedantic Guide to English explores language change, the ways in which language is used today, and how experts discuss conventions and usage. According to Kamm, experts can be divided into two camps: Linguists (who are...

The Internet of Things: Insights from CeBIT

One of the major events on the tech calendar is CeBIT, which takes place in Hannover, Germany annually, and brings together a wide spectrum of B2B industries. This year, the lead theme of the event, 'd!conomy: join – create – succeed', focused attention on the digital...

Techcomm Education: What’s Going On?

We recently learned that academic institutions in the UK are no longer providing third-level qualifications in technical communication. Several techcomm courses that had existed at various universities have been shut down. The topic of techcomm education was already...

Techcomm Today: Survey Findings

Techcomm education was a hot topic at the recent Technical Communications UK conference (TCUK), fuelling two panel sessions and many conversations outside of the formal programme. At the event, we conducted a survey exploring the qualifications, skills, knowledge, and...

Tips for Embarking on a Career in Technical Writing

I was recently invited to give a guest lecture to students at the University of Limerick (UL) in Ireland who are studying technical communication. The university offers a range of part-time and full-time courses in this area both for undergraduate and post-graduate...

TWi Named an Emergent Techcomm Leader in 2011

MindTouch, a US-based company that has developed a cloud-based help system of the same name, recently released a list of the most influential techcomm* leaders in 2011. We were delighted that Technically Write IT (TWi) was recognised as a techcomm leader by ranking...

Start your content transformation today.
https://technicallywriteit.com/twi-clients/our-impact-twi-client-stories/intel-augmented-support-for-the-internet-of-things/
technicallywriteit.com
CC-MAIN-2024-30
326623
application/http; msgtype=response
sha1:EULR2W4227KI5VYI6FNKCVYCALDXZSRS
<urn:uuid:f1ee7c21-2cfb-4745-ad8c-152c5d15610b>
2024-07-13T00:29:21Z
217.115.123.155
text/html
sha1:ANARLQP7VHPU6BJF3Q6W45ZPMUSJBQW5
<urn:uuid:3a1b1414-4867-4a77-afa6-be81602c2a85>
https://technicallywriteit.com/twi-clients/our-impact-twi-client-stories/intel-augmented-support-for-the-internet-of-things/
response
<urn:uuid:745c58e9-7d7d-4e5f-a4b8-5e08397942c5>
isPartOf: CC-MAIN-2024-30
publisher: Common Crawl
description: Wide crawl of the web for July 2024
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-13
software: Apache Nutch 1.20 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.5-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/