Technical Writer, Siemens Business Communication Systems
August 1997 to October 1998

Used FrameMaker on the PC to update legacy documentation and author new materials for the global rollout of the Hicom 150 E communications server. Worked with a team to gather information from SMEs and see our documents through QA and approval processes.

Later I took charge of global English service documentation for the product and supervised additional writers.

Phases I and II

• Edited two books for English grammar and style.
• Localized two books to fit the U.S. product.
• Authored a hardware installation guide.

Editing English Grammar and Style

We received some books as translations from Munich and revised them thoroughly in addition to localizing the content.

• Correcting grammar and punctuation
• Verifying terminology and concepts
• Rewriting vague passages
• Establishing consistency
• Eliminating excessive use of the passive
• Converting measurements
• Interfacing with the editor and completing a 26-page ISO publication checklist

We worked intensely with FrameMaker to produce documents up to 640 pages long.

• Conditional text
• Book building
• Siemens templates
• Markers
• Variables
• Change bars
• Frame art, anchored frames, text frames
• Paragraph and character tags
• Indexing

Localizing Content

We were charged with localizing documentation for a multinational product that had not yet arrived in the U.S. This made our SMEs unable to discuss more than 20% of the product until prototypes arrived.

• Reviewed specs in search of U.S. and world market differences.
• Patiently hounded SMEs until they had information and could provide it.
• Added U.S. features (power supply, trunk boards, mounting arrangements).
• Matched existing style using minimalism and Information Mapping.
• Removed non-U.S. features.
• Modified features that were implemented differently in the U.S.
• Produced simple Frame art and worked with an artist on more complex figures.
• Made PDF files, coordinated technical review, and resolved pending issues.
• Secured approvals for publication.

Authoring the Hardware Installation Guide

My greatest but most rewarding challenge was producing a 140-page installation guide from four pages of initial documentation.

• Planned the structure and direction of the document with product management.
• Revised structure, scope, and style each time the document’s audience changed.
• Worked closely with SMEs to develop content.
• Conducted usability testing and incorporated comments.
• Produced simple Frame art and worked with an artist on more complex figures.
• Mastered a second Siemens FrameMaker template.
• Made PDF files, coordinated technical review, and resolved pending issues.
• Interfaced with the editor and completed a 26-page ISO publication checklist.
• Secured approvals for publication.

Phase III

In July 1998 I traveled to Germany in my new role as lead technical writer for Siemens transnational documentation. After working out a new process, I returned to Santa Clara to head the realization team.

• Helped define a new process for handling country-specific features.
• Advised the German writers on writing for international audiences.
• Reached agreements on formatting and content details.
• Autonomously implemented the new process upon my return to Santa Clara.
• Saw existing documents through ISO procedures and publication.
• Edited the English in new translations of two books.
• Added U.S. specifics based on previous documentation and my product knowledge.
• Updated three documents for a new product release.
• Supervised additional writers as the workload grew.

March 1999

Returned to Siemens Communications (now Siemens ICN) to complete a short contract adding configuration notes and updating the service manual for a new release. Used my editing skills and product knowledge to verify and introduce new information for a worldwide technical audience.

Configuration Notes

• Used Word and FrameMaker to edit configuration notes and incorporate them into the existing document and its template.
• Edited language, terminology, and Information Mapping structure to match the existing manual.
• Used my product knowledge and my SME network to question and verify information.

Updates

• Identified and repaired incorrect and misleading information.
• Used my product knowledge to question information.
• Used my SME network to verify information.
• Cut and pasted information using FrameMaker.
• Updated variables and footer information for a new product release.
• Used my editing skills to adapt new pages translated in Munich to our existing global English manual.
• Interfaced with an artist to develop and incorporate new art.