Localization kits should include detailed guidelines for all the team members involved in the project, such as project managers, engineers, desktop publishers, and linguists.

The most important information for the project managers is an overview of project scope, milestones and requirements. Engineers expect guidelines on compilers and versions that need to be used for the online help or software, while desktop publishers need to know which application version, fonts, platform, and output settings to use.

1. PROJECT MANAGEMENT GUIDELINES

Project managers working for localization vendors would need the following information:

• Required tasks, services, and deliverables, e.g. only translation, or full engineering and testing. Refer to the List Of Expected Services and Deliverables section on page 51.

• Project scope overview, e.g. components, number of words to localize, languages, number of pages for DTP, number of updates that can be expected 

• General project release schedule, including milestones such as hand-offs, review cycles, and deliveries

• Quality steps, e.g. number of language reviews, online help functionality validation, software testing scope

• References to information on the product or product terminology, e.g. web sites or subject-matter dictionaries

• Contact information and communication methods

When scheduling a project, try to incorporate a realistic time frame for localization into the flow chart for product development. If something slips, adjust the time scheduled for localization accordingly.

2. SOFTWARE ENGINEERING GUIDELINES

Localization engineers need to know what resource files need to be localized, the hardware or software required to build the software, and how the compilation and testing phase is to be conducted.

Make sure the localization kit includes information on the following:

• Any specific requirements for the computer setup, such as hardware, platform, path settings, third party software, memory, etc.

• The version of the compiler that should be used to compile the localized software

• Instructions about compilation process, e.g. location of project files, language settings to change, batch files that need to be run

• List of files that require localization, and instructions on the text that needs to be localized and text that should stay in English

• For cosmetic testing of dialog boxes, include instructions on the operating system version and resolution settings that should be used

• Software testing approach/requirements. If functional testing is required, include test scripts.

3. ONLINE HELP OR HTML ENGINEERING GUIDELINES

Online help or HTML engineers need to know how to compile the help files, and how to test them.

For Windows Help, HTML. Help or web site localization projects, include the following information:

• Compilation procedure, i.e. the compiler version to be used, or a third-party application such as Robohelp to be installed

• List of files that require localization, and instructions on the text that needs to be localized and text that should stay in English

• Specifications for the images or screen captures, i.e. monitor resolution, color palette, file format, or fonts

• Specification of editor, i.e. version of Microsoft Word, or HTMI Editor

• A list of platforms, viewers, browsers and browser versions with which the localized online help or HTML project should be tested

• An overview of the authoring, multimedia and validation tools to be used on the source files

• An explanation of filtering processes used to load the source files in a translation memory tool, if applicable

• Testing approach, for example operating system, browser and browser version to be used for testing

• Specification of the language settings that need to be changed in the localized files, for example META tags in HTML. files