SlideShare a Scribd company logo
1 of 41
An Introduction to Translating Software Documentation Ryan Ginstrom
What I will talk about today ,[object Object],[object Object],[object Object],[object Object]
Many different types ,[object Object],[object Object]
Readers ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Target: end users vs. developers Load the application in X mode (run also OK) Run the program in X mode X モードでアプリケーションを起動する Deprecated Obsolete 推奨されない Debugging Troubleshooting 不具合の究明 Developers End users
Targets ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
What is good translation? ,[object Object],[object Object],[object Object],[object Object],[object Object]
Honing skills ,[object Object],[object Object],[object Object]
Honing technical knowledge ,[object Object],[object Object],[object Object]
Learn to program! ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Source language ,[object Object],[object Object],[object Object]
Rite away… ,[object Object],[object Object],[object Object],[object Object],[object Object]
Target language ,[object Object],[object Object]
Weaknesses abound ,[object Object],[object Object],[object Object]
We are translators ,[object Object],[object Object],[object Object]
Tools of the trade ,[object Object],[object Object],[object Object],[object Object]
Dictionaries ,[object Object],[object Object],[object Object]
Technical references ,[object Object],[object Object],[object Object],[object Object]
Others… ,[object Object],[object Object]
Technical style guides (online) ,[object Object],[object Object]
Technical style guides (dead trees) ,[object Object],[object Object]
From Microsoft Manual of Style ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
But from Sun’s manual… ,[object Object],[object Object],[object Object],[object Object],[object Object]
Microsoft Manual of Style on Usage Do not use in content for home users or information workers. Use  command  instead (c.f.  メニュー項目 ) menu item Avoid in all content as a verb; use  type  or another appropriate verb instead. (c.f.  入力 ) input Do not use  hint  as a heading for a type of note; use  tip  instead. hint Not  PC  or  machine  or  box , regardless of audience. computer In general, refer to a button only by its label. Correct: Select the file you want to open and then click  OK . button Avoid in content for home users and information workers; use  program  instead. application
Software ,[object Object],[object Object],[object Object],[object Object]
The good, the bad, and the ugly ,[object Object],[object Object],[object Object]
Exceptional ,[object Object],[object Object],[object Object],[object Object]
UGLY ,[object Object],[object Object],[object Object],例外の発生 :  Throw/raise an exception
Use the source, Luke! ,[object Object],[object Object]
BAD ,[object Object],[object Object],[object Object],Don’t be afraid to write English
Count on it ,[object Object],[object Object]
GOOD ,[object Object],[object Object],参照カウント : reference count 1  増加 :  increment 1  減少 :  decrement
More on exceptions ,[object Object],[object Object],[object Object],[object Object]
UGLY (trick question) ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],Convention!
The dating game ,[object Object],[object Object]
BAD ,[object Object],[object Object],[object Object],データ : File
What’s your destination? ,[object Object],[object Object]
UGLY ,[object Object],[object Object],[object Object],The user just wants to get the job done
More API stuff ,[object Object],[object Object]
BAD ,[object Object],[object Object],[object Object],範囲外 :  out of bounds
Thank You

More Related Content

Similar to Ijet Talk

Caring for file formats
Caring for file formatsCaring for file formats
Caring for file formatsAnge Albertini
 
Natural language processing: feature extraction
Natural language processing: feature extractionNatural language processing: feature extraction
Natural language processing: feature extractionGabriel Hamilton
 
Creating a compiler for your own language
Creating a compiler for your own languageCreating a compiler for your own language
Creating a compiler for your own languageAndrea Tino
 
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)Adrienne Bellehumeur
 
Full text search
Full text searchFull text search
Full text searchdeleteman
 
Best Practices In Terminology Research 2010
Best Practices In Terminology Research 2010Best Practices In Terminology Research 2010
Best Practices In Terminology Research 2010Valentini Mellas
 
CETS 2012, Mitch Donaldson & Ralph Strozza, slides for eLearning for Overseas...
CETS 2012, Mitch Donaldson & Ralph Strozza, slides for eLearning for Overseas...CETS 2012, Mitch Donaldson & Ralph Strozza, slides for eLearning for Overseas...
CETS 2012, Mitch Donaldson & Ralph Strozza, slides for eLearning for Overseas...Chicago eLearning & Technology Showcase
 
lecture2-PerlProgramming
lecture2-PerlProgramminglecture2-PerlProgramming
lecture2-PerlProgrammingtutorialsruby
 
lecture2-PerlProgramming
lecture2-PerlProgramminglecture2-PerlProgramming
lecture2-PerlProgrammingtutorialsruby
 
Envisioning the Future of Language Workbenches
Envisioning the Future of Language WorkbenchesEnvisioning the Future of Language Workbenches
Envisioning the Future of Language WorkbenchesMarkus Voelter
 
Nautral Langauge Processing - Basics / Non Technical
Nautral Langauge Processing - Basics / Non Technical Nautral Langauge Processing - Basics / Non Technical
Nautral Langauge Processing - Basics / Non Technical Dhruv Gohil
 
How To "Speak Developer"
How To "Speak Developer"How To "Speak Developer"
How To "Speak Developer"Nick Malcolm
 
Showing How Security Has (And Hasn't) Improved, After Ten Years Of Trying
Showing How Security Has (And Hasn't) Improved, After Ten Years Of TryingShowing How Security Has (And Hasn't) Improved, After Ten Years Of Trying
Showing How Security Has (And Hasn't) Improved, After Ten Years Of TryingDan Kaminsky
 
Margareth lota
Margareth lotaMargareth lota
Margareth lotamaggybells
 
Fundamentalsofprogrammingfinal 121011003536-phpapp02
Fundamentalsofprogrammingfinal 121011003536-phpapp02Fundamentalsofprogrammingfinal 121011003536-phpapp02
Fundamentalsofprogrammingfinal 121011003536-phpapp02thinesonsing
 

Similar to Ijet Talk (20)

Good programming
Good programmingGood programming
Good programming
 
PYTHON PPT.pptx
PYTHON PPT.pptxPYTHON PPT.pptx
PYTHON PPT.pptx
 
Caring for file formats
Caring for file formatsCaring for file formats
Caring for file formats
 
Natural language processing: feature extraction
Natural language processing: feature extractionNatural language processing: feature extraction
Natural language processing: feature extraction
 
vbaintro.pdf
vbaintro.pdfvbaintro.pdf
vbaintro.pdf
 
Creating a compiler for your own language
Creating a compiler for your own languageCreating a compiler for your own language
Creating a compiler for your own language
 
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
Documentation Workbook Series. Step 3 Presenting Information (Technical Writing)
 
Full text search
Full text searchFull text search
Full text search
 
Best Practices In Terminology Research 2010
Best Practices In Terminology Research 2010Best Practices In Terminology Research 2010
Best Practices In Terminology Research 2010
 
CETS 2012, Mitch Donaldson & Ralph Strozza, slides for eLearning for Overseas...
CETS 2012, Mitch Donaldson & Ralph Strozza, slides for eLearning for Overseas...CETS 2012, Mitch Donaldson & Ralph Strozza, slides for eLearning for Overseas...
CETS 2012, Mitch Donaldson & Ralph Strozza, slides for eLearning for Overseas...
 
DSL Best Practices
DSL Best PracticesDSL Best Practices
DSL Best Practices
 
lecture2-PerlProgramming
lecture2-PerlProgramminglecture2-PerlProgramming
lecture2-PerlProgramming
 
lecture2-PerlProgramming
lecture2-PerlProgramminglecture2-PerlProgramming
lecture2-PerlProgramming
 
Envisioning the Future of Language Workbenches
Envisioning the Future of Language WorkbenchesEnvisioning the Future of Language Workbenches
Envisioning the Future of Language Workbenches
 
Nautral Langauge Processing - Basics / Non Technical
Nautral Langauge Processing - Basics / Non Technical Nautral Langauge Processing - Basics / Non Technical
Nautral Langauge Processing - Basics / Non Technical
 
How To "Speak Developer"
How To "Speak Developer"How To "Speak Developer"
How To "Speak Developer"
 
Showing How Security Has (And Hasn't) Improved, After Ten Years Of Trying
Showing How Security Has (And Hasn't) Improved, After Ten Years Of TryingShowing How Security Has (And Hasn't) Improved, After Ten Years Of Trying
Showing How Security Has (And Hasn't) Improved, After Ten Years Of Trying
 
Margareth lota
Margareth lotaMargareth lota
Margareth lota
 
UNIT 5.pptx
UNIT 5.pptxUNIT 5.pptx
UNIT 5.pptx
 
Fundamentalsofprogrammingfinal 121011003536-phpapp02
Fundamentalsofprogrammingfinal 121011003536-phpapp02Fundamentalsofprogrammingfinal 121011003536-phpapp02
Fundamentalsofprogrammingfinal 121011003536-phpapp02
 

Recently uploaded

Digital magic. A small project for controlling smart light bulbs.
Digital magic. A small project for controlling smart light bulbs.Digital magic. A small project for controlling smart light bulbs.
Digital magic. A small project for controlling smart light bulbs.francesco barbera
 
UiPath Platform: The Backend Engine Powering Your Automation - Session 1
UiPath Platform: The Backend Engine Powering Your Automation - Session 1UiPath Platform: The Backend Engine Powering Your Automation - Session 1
UiPath Platform: The Backend Engine Powering Your Automation - Session 1DianaGray10
 
9 Steps For Building Winning Founding Team
9 Steps For Building Winning Founding Team9 Steps For Building Winning Founding Team
9 Steps For Building Winning Founding TeamAdam Moalla
 
UiPath Community: AI for UiPath Automation Developers
UiPath Community: AI for UiPath Automation DevelopersUiPath Community: AI for UiPath Automation Developers
UiPath Community: AI for UiPath Automation DevelopersUiPathCommunity
 
UiPath Studio Web workshop series - Day 7
UiPath Studio Web workshop series - Day 7UiPath Studio Web workshop series - Day 7
UiPath Studio Web workshop series - Day 7DianaGray10
 
RAG Patterns and Vector Search in Generative AI
RAG Patterns and Vector Search in Generative AIRAG Patterns and Vector Search in Generative AI
RAG Patterns and Vector Search in Generative AIUdaiappa Ramachandran
 
Machine Learning Model Validation (Aijun Zhang 2024).pdf
Machine Learning Model Validation (Aijun Zhang 2024).pdfMachine Learning Model Validation (Aijun Zhang 2024).pdf
Machine Learning Model Validation (Aijun Zhang 2024).pdfAijun Zhang
 
PicPay - GenAI Finance Assistant - ChatGPT for Customer Service
PicPay - GenAI Finance Assistant - ChatGPT for Customer ServicePicPay - GenAI Finance Assistant - ChatGPT for Customer Service
PicPay - GenAI Finance Assistant - ChatGPT for Customer ServiceRenan Moreira de Oliveira
 
Videogame localization & technology_ how to enhance the power of translation.pdf
Videogame localization & technology_ how to enhance the power of translation.pdfVideogame localization & technology_ how to enhance the power of translation.pdf
Videogame localization & technology_ how to enhance the power of translation.pdfinfogdgmi
 
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyesHow to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyesThousandEyes
 
Empowering Africa's Next Generation: The AI Leadership Blueprint
Empowering Africa's Next Generation: The AI Leadership BlueprintEmpowering Africa's Next Generation: The AI Leadership Blueprint
Empowering Africa's Next Generation: The AI Leadership BlueprintMahmoud Rabie
 
COMPUTER 10 Lesson 8 - Building a Website
COMPUTER 10 Lesson 8 - Building a WebsiteCOMPUTER 10 Lesson 8 - Building a Website
COMPUTER 10 Lesson 8 - Building a Websitedgelyza
 
NIST Cybersecurity Framework (CSF) 2.0 Workshop
NIST Cybersecurity Framework (CSF) 2.0 WorkshopNIST Cybersecurity Framework (CSF) 2.0 Workshop
NIST Cybersecurity Framework (CSF) 2.0 WorkshopBachir Benyammi
 
Introduction to Matsuo Laboratory (ENG).pptx
Introduction to Matsuo Laboratory (ENG).pptxIntroduction to Matsuo Laboratory (ENG).pptx
Introduction to Matsuo Laboratory (ENG).pptxMatsuo Lab
 
Comparing Sidecar-less Service Mesh from Cilium and Istio
Comparing Sidecar-less Service Mesh from Cilium and IstioComparing Sidecar-less Service Mesh from Cilium and Istio
Comparing Sidecar-less Service Mesh from Cilium and IstioChristian Posta
 
UiPath Solutions Management Preview - Northern CA Chapter - March 22.pdf
UiPath Solutions Management Preview - Northern CA Chapter - March 22.pdfUiPath Solutions Management Preview - Northern CA Chapter - March 22.pdf
UiPath Solutions Management Preview - Northern CA Chapter - March 22.pdfDianaGray10
 
Artificial Intelligence & SEO Trends for 2024
Artificial Intelligence & SEO Trends for 2024Artificial Intelligence & SEO Trends for 2024
Artificial Intelligence & SEO Trends for 2024D Cloud Solutions
 
Basic Building Blocks of Internet of Things.
Basic Building Blocks of Internet of Things.Basic Building Blocks of Internet of Things.
Basic Building Blocks of Internet of Things.YounusS2
 
Cybersecurity Workshop #1.pptx
Cybersecurity Workshop #1.pptxCybersecurity Workshop #1.pptx
Cybersecurity Workshop #1.pptxGDSC PJATK
 
Linked Data in Production: Moving Beyond Ontologies
Linked Data in Production: Moving Beyond OntologiesLinked Data in Production: Moving Beyond Ontologies
Linked Data in Production: Moving Beyond OntologiesDavid Newbury
 

Recently uploaded (20)

Digital magic. A small project for controlling smart light bulbs.
Digital magic. A small project for controlling smart light bulbs.Digital magic. A small project for controlling smart light bulbs.
Digital magic. A small project for controlling smart light bulbs.
 
UiPath Platform: The Backend Engine Powering Your Automation - Session 1
UiPath Platform: The Backend Engine Powering Your Automation - Session 1UiPath Platform: The Backend Engine Powering Your Automation - Session 1
UiPath Platform: The Backend Engine Powering Your Automation - Session 1
 
9 Steps For Building Winning Founding Team
9 Steps For Building Winning Founding Team9 Steps For Building Winning Founding Team
9 Steps For Building Winning Founding Team
 
UiPath Community: AI for UiPath Automation Developers
UiPath Community: AI for UiPath Automation DevelopersUiPath Community: AI for UiPath Automation Developers
UiPath Community: AI for UiPath Automation Developers
 
UiPath Studio Web workshop series - Day 7
UiPath Studio Web workshop series - Day 7UiPath Studio Web workshop series - Day 7
UiPath Studio Web workshop series - Day 7
 
RAG Patterns and Vector Search in Generative AI
RAG Patterns and Vector Search in Generative AIRAG Patterns and Vector Search in Generative AI
RAG Patterns and Vector Search in Generative AI
 
Machine Learning Model Validation (Aijun Zhang 2024).pdf
Machine Learning Model Validation (Aijun Zhang 2024).pdfMachine Learning Model Validation (Aijun Zhang 2024).pdf
Machine Learning Model Validation (Aijun Zhang 2024).pdf
 
PicPay - GenAI Finance Assistant - ChatGPT for Customer Service
PicPay - GenAI Finance Assistant - ChatGPT for Customer ServicePicPay - GenAI Finance Assistant - ChatGPT for Customer Service
PicPay - GenAI Finance Assistant - ChatGPT for Customer Service
 
Videogame localization & technology_ how to enhance the power of translation.pdf
Videogame localization & technology_ how to enhance the power of translation.pdfVideogame localization & technology_ how to enhance the power of translation.pdf
Videogame localization & technology_ how to enhance the power of translation.pdf
 
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyesHow to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
How to Effectively Monitor SD-WAN and SASE Environments with ThousandEyes
 
Empowering Africa's Next Generation: The AI Leadership Blueprint
Empowering Africa's Next Generation: The AI Leadership BlueprintEmpowering Africa's Next Generation: The AI Leadership Blueprint
Empowering Africa's Next Generation: The AI Leadership Blueprint
 
COMPUTER 10 Lesson 8 - Building a Website
COMPUTER 10 Lesson 8 - Building a WebsiteCOMPUTER 10 Lesson 8 - Building a Website
COMPUTER 10 Lesson 8 - Building a Website
 
NIST Cybersecurity Framework (CSF) 2.0 Workshop
NIST Cybersecurity Framework (CSF) 2.0 WorkshopNIST Cybersecurity Framework (CSF) 2.0 Workshop
NIST Cybersecurity Framework (CSF) 2.0 Workshop
 
Introduction to Matsuo Laboratory (ENG).pptx
Introduction to Matsuo Laboratory (ENG).pptxIntroduction to Matsuo Laboratory (ENG).pptx
Introduction to Matsuo Laboratory (ENG).pptx
 
Comparing Sidecar-less Service Mesh from Cilium and Istio
Comparing Sidecar-less Service Mesh from Cilium and IstioComparing Sidecar-less Service Mesh from Cilium and Istio
Comparing Sidecar-less Service Mesh from Cilium and Istio
 
UiPath Solutions Management Preview - Northern CA Chapter - March 22.pdf
UiPath Solutions Management Preview - Northern CA Chapter - March 22.pdfUiPath Solutions Management Preview - Northern CA Chapter - March 22.pdf
UiPath Solutions Management Preview - Northern CA Chapter - March 22.pdf
 
Artificial Intelligence & SEO Trends for 2024
Artificial Intelligence & SEO Trends for 2024Artificial Intelligence & SEO Trends for 2024
Artificial Intelligence & SEO Trends for 2024
 
Basic Building Blocks of Internet of Things.
Basic Building Blocks of Internet of Things.Basic Building Blocks of Internet of Things.
Basic Building Blocks of Internet of Things.
 
Cybersecurity Workshop #1.pptx
Cybersecurity Workshop #1.pptxCybersecurity Workshop #1.pptx
Cybersecurity Workshop #1.pptx
 
Linked Data in Production: Moving Beyond Ontologies
Linked Data in Production: Moving Beyond OntologiesLinked Data in Production: Moving Beyond Ontologies
Linked Data in Production: Moving Beyond Ontologies
 

Ijet Talk

  • 1. An Introduction to Translating Software Documentation Ryan Ginstrom
  • 2.
  • 3.
  • 4.
  • 5. Target: end users vs. developers Load the application in X mode (run also OK) Run the program in X mode X モードでアプリケーションを起動する Deprecated Obsolete 推奨されない Debugging Troubleshooting 不具合の究明 Developers End users
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24. Microsoft Manual of Style on Usage Do not use in content for home users or information workers. Use command instead (c.f. メニュー項目 ) menu item Avoid in all content as a verb; use type or another appropriate verb instead. (c.f. 入力 ) input Do not use hint as a heading for a type of note; use tip instead. hint Not PC or machine or box , regardless of audience. computer In general, refer to a button only by its label. Correct: Select the file you want to open and then click OK . button Avoid in content for home users and information workers; use program instead. application
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.
  • 30.
  • 31.
  • 32.
  • 33.
  • 34.
  • 35.
  • 36.
  • 37.
  • 38.
  • 39.
  • 40.