intel style manual

24
How To Communicate A Style Manual For the Intel Software Program

Upload: vi-ku

Post on 27-Dec-2015

64 views

Category:

Documents


1 download

DESCRIPTION

Intel Style Manual

TRANSCRIPT

How To Communicate

A Style Manual For the Intel Software

Program

Table of Contents

List of Figures iii.

Introduction 1.

Abbreviations 2.

Acronyms 3.

Bias Language 9.

Capitalization 10.

Foreign Languages 10.

Headings and Titles 10.

Hyphenation 14.

Italics 15.

Numbers 15.

Punctuation 16.

Spelling 16.

Index 19.

ii

List of Figures

Figure 1. Slide Example 1 12.

Figure 2. Slide Example 2 13.

iii

1

Introduction In order to help the communications of the Intel SSG team of MarketStar maintain consistency

and accuracy, this style guide has been comprised in accordance with the grammar rules and

style found in the Chicago Manual of Style 16th

edition. Additionally, the specific technical

terminology used by the Intel SSG team has been properly identified and organized. It has been

analyzed and placed in the respective categories that follow. This style manual shows how the

various technical terms should be communicated, as has been decided by the Intel SSG team and

authors of this style guide.

Despite the generalities associated with some of the terms and usage models mentioned herein,

the SSG team and the authors of this style manual have chosen the most common and

appropriate ways that these specific terms should be used. The purpose of these decisions is to

maintain consistency and to effectively communicate the expectations of the industry.

2

Abbreviations

Abbreviations in the writings of the Intel SSG sector are not very excessive, unlike acronyms,

about which you can read on the following page. Nonetheless, here is a list of the most common

abbreviations and their definitions.

Intel - Intelligence (Though Intel is technically an abbreviation of the word intelligence, Intel is

not an abbreviated version of the company name. The company name is Intel and is never

referred to as anything else.

Ts and Cs - Terms and Conditions, referring to Terms and Conditions Agreement. This is similar

to an acronym but is never used in the acronym form. TCs is an incorrect usage and is never used

to mean the same thing.

Int - International

Specs - Specifications

Apps - Applications

Rep - Representative

Adv - Advanced

Sec - Second (However, the use of the plural abbreviation of second is forbidden, because it is

phonetically identical to another term that should not be talked about in the work place. If the

plural form of seconds is needed, it should be written or spoken as seconds and never

abbreviated.)

3

Acronyms

In the world of Intel, acronyms are a staple of the verbal and written diet. Learning to effectively

use them is a huge step toward more efficient communication in the business. The following list

is not entirely comprehensive, being that there is a whole dictionary of acronyms drafted for the

many departments and programs within Intel, but this list comprises the most common acronyms

used in the Intel Software Partner Program and the terms that those acronyms represent.

It should be noted that when using Intel acronyms in writing, it is not necessary, nor is it

appropriate, to include periods between each letter. For example, ISV (Independent Software

Vender) is represented as shown, and not as I.S.V. In every case, these acronyms must also be

capitalized for every letter involved (ISV, not isv).

A

AE - Applications Engineer

AET - Application Engineer Technician

APAC - Asia Pacific

AR - Action Requirement

ASMO - American Sales and Marketing Organization

ASP - Average Selling Price

B

BDF - Business Development Funds

BDO - Business Development Organization

BKM - Best Known Method

BTR - Bit Testing Reset

BTS - Bit Testing Set

4

BUM - Business Update Meeting

C

CA - Concept Approval

CAGR - Compound Annual Growth Rate

CE - Consumer Electronics

CMT - Centrino Mobile Technology

CNDA - Corporate Non-Disclosure Agreement

CRM - Corporate Records Management

CTG - Corporate Technology Group

D

DHWG - Digital Home Working Group

DIA - Development Investment Approval

DMA - Digital Media Adaptor

DP - Dual Processor

DPS - Development Platforms and Services

DRM - Developer Relations Manager - Tiers 3 & 4 (Low Touch)

DRM - Digital Rights Management

DSM - Dynamic Strategy Mapping

E

EAI - Enterprise Application Integration

EAP - Early Access Program

EC - Enterprise Client

ECMP - EAP Co-Marketing Portal

5

EIB - Extended Ingredient Brand

EMEA - Europe, Middle East, and Africa

EOQ - End of Quarter

EOY - End of Year

ETE - Enterprise Technology Enabling

F

FAQ - Frequently Asked Question

FOM - Friends of Management

FSB - Front Side Bus

G

GTM - Go To Market

H

HIIP - Hewlett Packard Intel Itanium Program

HPC - High Performance Computing

HT - Hyper Threading

HPTC - High Performance Technical Computing

HW - Hardware

I

I/O - Input / Output

IA - Intel Architecture

ICAP - Intel Capital

IHV - Independent Hardware Vendor

6

IJKK - Intel Japan

ILN - Intel Learning Network

IMON - Intel Marketing Opportunity Network

IPF - Itanium Processor Family

IPLA - Intel Platform Licensing Agreement

IPP - Intel Integrated Performance Primitives

ISMC - Intel (or International) Sales & Marketing Conference (every year in

January)

ISS - Intel Solution Services

ISV - Independent Software Vendor

L

LAR - Latin America

LOB - Line of Business

LT - Legran Technology (security)

LV - Low Voltage

M

MBO - Management by Objectives

MP - Multi Processor

MRD - Marketing Requirement Document

MRTE - Managed Run-Time Environment

MSI - Mobilized Software Initiative

MSR - Monthly Status Report

MSS - Market Segment Share

7

N

NGIP - Next Generation Intel Platform

O

OBM - Out-Bound Marketing

OCC - Occasionally Connected Computing

OEM - Original Equipment Manufacturer

OS - Operating System

P

P4P - Pentium 4 Platform

PAS - Program Account Specialist - Tiers 3 & 4 (Low Touch)

PC - Personal Computer

PCA - Personal Client Architecture (X-Scale)

PDT - Program (or Product) Development Team

PEL - Performance Enabling Lab

PET - Performance Enhancing Technology

PLBP - Product Line Business Plan

PLC - Product Life Cycle

PMR - Promotional Materials Release

POC - Point of Contact

PPC - Program (or Product) Planning Committee

PRC - People's Republic of China

PTE - Platform Technical Engineer

PVR - Personal Video Recorder

8

R

RA - Remote Access

RASM - Reliability, Availability, Scalability, Manageability

RDM - Roadmap Decision Meeting

ROI - Return on Investment

S

SDP - Software Development Platform

SDTT - Solution Development Tracker Tool

SDV - Software Development Vehicle

SED - Software Enabling Division

SFA - Solution Focus Area

SI - Systems Integration

SLRP - Strategic Long Range Plan

SMDG - Solution Market Development Group

SOW - Statement of Work

SPP - Software Partner Program

SPU - Segment Product Update

SRM - Strategic Relations Manager - Tiers 1 & 2 (High Touch)

STRC - Software Tiering Review Council

SW - Software

T

TAM - Total Available Market

TCO - Total Cost of Ownership

9

TMM - Technical Marketing Manager

TVO - Total Value of Opportunity

U

UPnP - Universal Plug and Play

W

WCCG - Wireless Communications & Computing Group

WLE - Work Life Effectiveness

WNG - Wireless Networking Group

WS - Workstation

X

XPF - Xeon Processor Family

XPG - X Product Groups (X = any of the product groups at Intel [e.g., MPG

(mobile), DPG (desktop), EPG (enterprise), etc.])

Y

YTD - Year to Date

Z

ZBB - Zero Base Balance

10

Biased language

Biased language can easily be avoided by the use of titles, such as IEM or rep when referring to

coworkers, or titles such as programmer or employee, when referring to those with whom we

work in our respective companies. (e.g. The programmer needs to upload the tool report file to

see the results, rather than He needs to upload the tool report file to see the results.)

Capitalization

Capitalization rules apply as they would in any other writing. However, one example to be

mentioned specifically is the use of the Intel name in writing. Though Intel lists its name as intel

(all lower case) in its logo, it is never appropriate to write Intel in lower case in any written

communication. It should also be remembered, as mentioned in the section on acronyms, that all

acronyms are to be capitalized regardless as to where they fall in any sentence or heading.

Foreign Languages

Intel operates in the global market in nearly every case. However, where product names are

concerned, the original English spellings remain. For example, Intel SandyBridge (a name

referring to the CPUs built on the SandyBridge architecture) remains as Intel SandyBridge when

communicated to a Spanish-speaking customer, rather than calling it Intel Puente Areñoso. Of

course, this applies to all other foreign languages as well.

11

Headings and Titles

Headings and titles used within the communications of the Intel Software team vary widely. They

are applied in documentations in Word, PowerPoint, and Excel. There is no reason to restrict

creativity in these respective applications and, accordingly, this section will make no attempt at

such. However, there are a few fundamentals that need to be addressed.

Emails:

Aside from attachments, all email communications should maintain relatively plain text in both the

body of the message and the subject line.

Subject Line: The subject line itself should be written in title format with the first letter of

each word capitalized. All caps is not appropriate in regular communication. There is also

no need for bolding the subject line or placing it in an irregular font.

Excel:

All Excel headings should be bolded, but not necessarily all caps. Any titles used in the Excel

should be simplistic and professional, but there is no designation on what font size or style should

be used.

12

PowerPoint:

PowerPoint presentations allow for liberal use of font sizes and styles, as well as unlimited

possibilities for layout. However, each PowerPoint slide should maintain, as all other

documentation, a professional appearance with sensible and systematic page orientations. The

following two slide examples express differences in extravagance, but also the consistent approach

to professionalism and sensibility. Use these as a model of the expectations.

Additionally, in the titles and headings of all documentation, the Intel name, whenever it is used,

should be accompanied by the registered trademark icon. This, however, is not necessary for the

usage of Intel in the body of the text.

Slide Example 1

13

Slide Example 2

Word Documentation:

In the case of all word documentation, there is no rule or expectation for the specific font or layout

of any title or heading used. However, conservative and business-appropriate formats are expected.

The following page shows a good example.

14

<NAME>,

Today’s business and consumer computer users have come to expect the performance of multiple cores. Thread your client or server applications for Intel multi-core technology to help ensure that your software offers the best performance and features for your customers. Develop your multi-core application for the latest multi-core technology by enabling for n-core, 8-core or 4-core processing, future-proofing your application for best results.

The Intel Software Partner Program provides these FREE resources to start your multi-core project and bring your solution to the global market:

Deep dive into the details with the Developer Community. Collaborate with experts in the Parallel Programming community and gain access to technology overviews, white papers, code samples, developer’s guides, and more.

Development tools. Intel Concurrent Collections, Intel Cluster Poisson Solver Library, Intel Parallel Advisor Lite, Intel Software Development Emulator, and many more tools for you to download.

Intel Software Assessment Tools. Get help in your development process with specific measurements of how well your application takes advantage of Intel technologies. Use the free Intel Concurrency Checker to evaluate your application for Intel multi-core technology-based systems.

Get It to Market

Once your development work is done, ramp up your marketing efforts with custom collateral, logos,

research reports, and a wealth of how-to documents to help you get your software application to

market and increase sales. Read success stories on how members have optimized their solutions for

Intel technologies.

It's Time to Get Started

Everything you need to start a project and go to market is available when you need it. Please let

me know if you have questions or need any assistance from me to help you get started.

Name: Title, Intel Software Partner Program

Telephone: XXXXXXXXXX

Copyright © 2010, Intel Corporation. Intel, Intel Graphics, and the Intel logo are trademarks of Intel

Corporation in the U.S. and other countries. All rights reserved. *Other names and brands may be

claimed as the property of others

1 McCarron, Dean, 2008, for Mercury Research, PC Graphics 2008; Updated Edition4Q2008 Report.

Available at www.mercuryresearch.com

15

Hyphenation

A general rule for hyphenation is to use it only in cases where two words form a compound

adjective, such as Intel-enabled application. Although, in the case of terms within the Intel Software

Partner Program, it is universally held that no hyphenations are to be used. This also applies to the

following list of common Intel words and designations:

Graphics Performance Analyzer

Graphics Checker Tool

Multicore

Power Assessment Tool

Furthermore, these rules do not include cases where the hyphenation is part of the word’s spelling.

There are many compound words in the English language that are always spelled with

hyphenation, such as part-time and full-time, whether used as a noun or adjective.

The following list comprises a small number of words that could be used in the Intel Software

team’s line of work. The list is by no means comprehensive. All inquiries not answered here

should be easily resolved by referring to a comprehensive English dictionary. Ultimately, there are

not many common hyphenated words indigenous to the nature of the Intel Software team’s work.

Common Hyphenated Words:

All-inclusive

All-expense-paid

Ex-corporate

Full-time

One-half

One-third (and all other fractions and compound numbers, such as in the case of

thirty-one)

Part-time

All words that would be difficult to read without a hyphen, such as the following:

o Non-transferrable (not nontransferable)

o Ex-member (not exmember)

o Co-part (not copart)

o Re-enroll (not reenroll)

16

Italics

Italics should be used sparingly. In most cases, the only real use this team will ever have for it is to

list the name of a book or periodical in the body of the text, such as PC Magazine. Another more

infrequent case is the use of italics for emphasis. However, this should be drastically limited.

Consider the following example:

Example: When uploading the tool report file do not forget to select your install base range.

Numbers

When using numbers in the body of text, they should be dealt with according to the size of the

number. For small numbers, such as one, two, three, and even as high as one-hundred, it is

expected that one spells out these designations as shown here. However, when the number

referenced is larger in comparison, such as in the hundreds of thousands, it is appropriate to list it

in its numeric value.

Example: The install base of the ISV is 250,000. (Rather than The install base of the ISV is two-

hundred fifty thousand.)

Additionally, in the case of exceedingly large numbers, such as millions, it is appropriate and

expected to use a combination of both forms to limit the number of characters needed.

Example: The ISV’s install base is 1.5 mill. (Rather than: The ISV’s install base is 1,500,000.)

Note: It should be understood that these same rules do not apply in such cases as

spreadsheets, or anywhere else where number analysis, comparison, or summation are necessary.

17

Punctuation

When considering periods, question marks, and exclamation points, there are only two that are

often used in the writings of the Intel team: periods and question marks. The exclamation point is

an indication of a heightened tone of excitement or frustration and, therefore, should almost never

be used in professional communications. On occasion, you may see it utilized in advertising an

exciting new advance in Intel technology, such as the example below.

Example: The New Intel Ivy Bridge Raises Industry Expectations!

While the exclamation here can be warranted, it is still just as well to end the phrase with a period.

In other words, within Intel, the exclamation point is usually unnecessary, but can be used at times

with discretion. Also, remember to use commas properly: after an introductory phrase, around a

parenthetical statement, in the serial case, and (perhaps most of all) in the case of a compound

sentence. Make certain not to use only a comma in the case of a compound sentence but to

include the proper conjunction or else a semicolon.

Spelling

When addressing proper spelling, it is important to be careful and scrupulous. The spell-checking

tool is a useful aid, but it doesn’t catch every error. For example, in every case, a spell checker will

miss homonyms. These are words that sound the same but are spelled differently, and there are

plenty of instances of this in the English language.

Example: Don’t worry to much about getting that done today. We can address it more fully

tomorrow.

This example uses the wrong form of “to”. It should be “too much” instead of “to much”. The

most updated versions of Microsoft Word will now mark such errors in green or blue, but the

spell checker will do nothing about it.

18

On a related note, no one should ever rely on Microsoft Word’s grammar check tool. It gets things

wrong far more often than it gets them right. People are best off considering it nonexistent.

Certain spellings of Intel products skirt the rules of proper spelling, and are commonly used

among the Intel team, such as the following three:

Ultrabook

Multicore

SandyBridge

In any other case, these would be separate words or else hyphenated spellings. However, as Intel

trademarks, they are spelled accordingly within the Intel environment.

Index

19

Abbreviations, 2 Acronyms, 3 Adv, 2 AE, 3 AET, 3 All-expense-paid, 15 All-inclusive, 15 APAC, 3 Apps, 2 AR, 3 ASMO, 3 ASP, 3 BDF, 3 BDO, 3 Bias language, 10 BKM, 3 BTR, 3 BTS, 3 BUM, 4 CA, 4 CAGR, 4 Capitalization, 10 CE, 4 CMT, 4 CNDA, 4 Co-part, 15 CRM, 4 CTG, 4 DHWG, 4 DIA, 4 DMA, 4 DP, 4 DPS, 4 DRM, 4 DSM, 4 EAI, 4 EAP, 4 EC, 4 ECMP, 5 EIB, 5 Emails, 11 EMEA, 5 EOQ, 5 EOY, 5 ETE, 5

Excel, 11 Ex-corporate, 15 Ex-member, 15 FAQ, 5 FOM, 5 Foreign languages, 10 FSB, 5 Full-time, 15 Graphics Checker Tool, 15 Graphics Performance Analyzer, 15 GTM, 5 Headings, 11 HIIP, 5 HPC, 5 HPTC, 5 HT, 5 HW, 5 Hyphenation, 15 I/O, 5 IA, 5 ICAP, 5 IHV, 6 IJKK, 6 ILN, 6 IMON, 6 Int, 2 Intel. See 2, 10, 13, 14 IPF, 6 IPLA, 6 IPP, 6 ISMC, 6 ISS, 6 ISV, 6 Italics, 16 LAR, 6 LOB, 6 LT, 6 LV, 6 MBO, 6 MP, 6 MRD, 6 MRTE, 6 MSI, 6 MSR, 6 MSS, 7

Multicore. See 2 and 18 NGIP, 7 Non-tranferrable, 15 Numbers, 16 OBM, 7 OCC, 7 OEM, 7 One-half, 15 One-third, 15 OS, 7 P4P, 7 Part-time, 15 PAS, 7 PC, 7 PCA, 7 PDT, 7 PEL, 7 PET, 7 PLBP, 7 PLC, 7 PMR, 7 POC, 7 Power Assessment Tool, 15 PowerPoint, 12

PPC, 7 PRC, 7 PTE, 8 Punctuation, 17 PVR, 8 RA, 8 RASM, 8 RDM, 8 Re-enroll, 15 Rep, 2 ROI, 8 SandyBridge, 10

20.

SDP, 8 SDTT, 8 SDV, 8 Sec, 2 SED, 8 SFA, 8 Shez, 2 SI, 8 SLRP, 8 SMDG, 8 SOW, 8 Spanish-speaking, 10 Specs, 2 Spelling, 17 SPP, 8 SPU, 8 SRM, 8 STRC, 8 SW, 8 TAM, 9 TCO, 9 Titles, 11 TME, 9 Ts and Cs, 2 TVO, 9 Ultrabook, 18 UPnP, 9 WCCG, 9 WLE, 9 WNG, 9 Word Documentation, 13 WS, 9 XPF, 9 XPG, 9 YTD, 9 ZBB, 9