Presentation is loading. Please wait.

Presentation is loading. Please wait.

An Introduction to Translating Software Documentation Ryan Ginstrom.

Similar presentations


Presentation on theme: "An Introduction to Translating Software Documentation Ryan Ginstrom."— Presentation transcript:

1 An Introduction to Translating Software Documentation Ryan Ginstrom

2 What I will talk about today What is it? Honing skills Tools of the trade The good, the bad, and the ugly

3 Many different types Readers Targets

4 Readers End users Programmers “Pointy-haired people” – Marketing – Managers – Purchasing departments…

5 Target: end users vs. developers End usersDevelopers 不具合の究明 TroubleshootingDebugging 推奨されない ObsoleteDeprecated X モードでアプリ ケーションを起 動する Run the program in X mode Load the application in X mode (run also OK)

6 Targets Platform – Microsoft / *Nix / Mac / Web application / mobile devices Layer – Device driver / desktop application / online shopping cart / Webmail Purpose – Instruct / inform / publicize

7 What is good translation? Should read like a target-language document Not like a translation Write for the reader – Needs – Expectations

8 Honing skills Technical knowledge Knowledge of source language Technical writing

9 Honing technical knowledge Read one technical book in our target language per month – Think about that Learn to program?

10 Learn to program! Python – www.python.org www.python.org – Easy to learn – Powerful Ruby – http://www.ruby-lang.org/ http://www.ruby-lang.org/ – Powerful – “Made in Japan” Visual Basic – Pros: Simple, useful – Con: Dead (replaced by VB.NET)

11 Source language Know the terminology in the source language Read fluently “Good enough” isn’t

12 Rite away… English original (method description): Performs last rites on the object. Japanese translation: オブジェクトに対して最終書き込みを行います。 ??

13 Target language Technical writing Pretending to sound like you know what you’re talking about

14 Weaknesses abound We’re not engineers We’re not technical writers We’re not native speakers of one of our languages

15 We are translators Humility (but not too much!) Keep an open mind Constantly learn

16 Tools of the trade Dictionaries Technical references Technical style guides Software

17 Dictionaries 電気情報和英辞典 オーム社 編 数学 英和・和英辞典 小松勇作 編 和英 コンピュータ用語大辞典 Japanese-English Dictionary of Computer (AKA “The Lacker”)

18 Technical references O’Reilly’s “In a Nutshell” series Books on software development Textbooks Mostly target language

19 Others… The Windows Interface Guidelines for Software Design Developing User Interfaces for Microsoft Windows

20 Technical style guides (online) Apple Publications Style Guide (PDF) http://developer.apple.com/documentation/ Sun – Writing for the Web http://www.sun.com/980713/webwriting/

21 Technical style guides (dead trees) Microsoft Manual of Style for Technical Publications Read Me First! A Style Guide for the Computer Industry (Sun)

22 From Microsoft Manual of Style Correct On the File menu, click Open. Incorrect On the File menu, choose the Open command. Reference: [ ファイル ] メニューから [ 開く ] コマンドを選択し …

23 But from Sun’s manual… Menu option names appear in the document’s default font and do not receive any special typographic styling. From the Edit menu, choose Paste. (or) Choose Edit  Paste. -- Read Me First!

24 Microsoft Manual of Style on Usage application Avoid in content for home users and information workers; use program instead. button In general, refer to a button only by its label. Correct: Select the file you want to open and then click OK. computer Not PC or machine or box, regardless of audience. hint Do not use hint as a heading for a type of note; use tip instead. input Avoid in all content as a verb; use type or another appropriate verb instead. (c.f. 入力 ) menu item Do not use in content for home users or information workers. Use command instead (c.f. メニュー項目 )

25 Software Translation memory Online/electronic dictionaries Text to speech/dictation Gluing

26 The good, the bad, and the ugly Sample source and translation You make the call Then look at what I thought when I wrote this

27 Exceptional Japanese original このメソッドでは、要 素の取得に失敗する 場合、例外が発生し ます。 English translation In this method, an exception occurs if the acquisition of the element fails.

28 UGLY このメソッドでは、要素 の取得に失敗する場合、 例外が発生します。 In this method, an exception occurs if the acquisition of the element fails. This method throws an exception if it fails to acquire the element. 例外の発生 : Throw/raise an exception

29 Use the source, Luke! ファイルの保存時に保存 元と保存先のファイル 内容を比較する When saving a file, the contents of the save source and save destination files are compared

30 BAD ファイルの保存時に保存 元と保存先のファイル 内容を比較する When saving a file, the contents of the save source and save destination files are compared When you save the file, the original file and the file to be saved are compared. Don’t be afraid to write English

31 Count on it この参照カウントは、 LoadLibrary 関数が呼び 出されるたびに 1 増加 し、 FreeLibrary 関数が 呼び出されるたびに 1 減少します。 This reference count is incremented each time LoadLibrary is called and decremented each time FreeLibrary is called.

32 GOOD この参照カウントは、 LoadLibrary 関数が呼び 出されるたびに 1 増加 し、 FreeLibrary 関数が 呼び出されるたびに 1 減少します。 This reference count is incremented each time LoadLibrary is called and decremented each time FreeLibrary is called. 参照カウント :reference count 1 増加 : increment 1 減少 : decrement

33 More on exceptions 例外 : XYZException - 引数 foo が null の場合に 発生します。 Exceptions: XYZException – Thrown if parameter foo is null.

34 UGLY (trick question) 例外 : XYZException - 引数 foo が null の場合に発生し ます。 Exceptions: XYZException – Thrown if parameter foo is null. Throws: XYZException – If parameter foo is null. Convention!

35 The dating game このサンプルでは、これ らのテーブルを XML データとして保存しま す。 In this sample, these tables are saved as XML data.

36 BAD このサンプルでは、これ らのテーブルを XML データとして保存しま す。 In this sample, these tables are saved as XML data. In this sample, these tables are saved as an XML file. データ : File

37 What’s your destination? 保存先のフォルダを開い て,「 foo. exe」を ダブルクリックして下 さい。 Open the save destination folder, and double click the “foo.exe” icon.

38 UGLY 保存先のフォルダを開い て,「 foo. exe」を ダブルクリックして下 さい。 Open the save destination folder, and double click the “foo.exe” icon. Open the folder where you saved the file, and click on the “foo.exe” icon. The user just wants to get the job done

39 More API stuff インデックスが範囲外の 場合に 黒色 ( 0, 0, 0 ) を返します。 If the index is outside the scope, returns black (0, 0, 0).

40 BAD インデックスが範囲外の 場合に 黒色 ( 0, 0, 0 ) を返します。 If the index is outside the scope, returns black (0, 0, 0). If the index is out of bounds, returns black (0, 0, 0). 範囲外 : out of bounds

41 Thank You


Download ppt "An Introduction to Translating Software Documentation Ryan Ginstrom."

Similar presentations


Ads by Google