SlideShare a Scribd company logo
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

Good programming
Good programmingGood programming
Good programming
Won Kwang University
 
PYTHON PPT.pptx
PYTHON PPT.pptxPYTHON PPT.pptx
PYTHON PPT.pptx
AbhishekMourya36
 
Caring for file formats
Caring for file formatsCaring for file formats
Caring for file formats
Ange Albertini
 
Natural language processing: feature extraction
Natural language processing: feature extractionNatural language processing: feature extraction
Natural language processing: feature extraction
Gabriel Hamilton
 
vbaintro.pdf
vbaintro.pdfvbaintro.pdf
vbaintro.pdf
ayshaukat05
 
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
Andrea 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 search
deleteman
 
Best Practices In Terminology Research 2010
Best Practices In Terminology Research 2010Best Practices In Terminology Research 2010
Best Practices In Terminology Research 2010
Valentini 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
 
DSL Best Practices
DSL Best PracticesDSL Best Practices
DSL Best Practices
Markus Voelter
 
lecture2-PerlProgramming
lecture2-PerlProgramminglecture2-PerlProgramming
lecture2-PerlProgramming
tutorialsruby
 
lecture2-PerlProgramming
lecture2-PerlProgramminglecture2-PerlProgramming
lecture2-PerlProgramming
tutorialsruby
 
Envisioning the Future of Language Workbenches
Envisioning the Future of Language WorkbenchesEnvisioning the Future of Language Workbenches
Envisioning the Future of Language Workbenches
Markus 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 Trying
Dan Kaminsky
 
Margareth lota
Margareth lotaMargareth lota
Margareth lota
maggybells
 
UNIT 5.pptx
UNIT 5.pptxUNIT 5.pptx
Fundamentalsofprogrammingfinal 121011003536-phpapp02
Fundamentalsofprogrammingfinal 121011003536-phpapp02Fundamentalsofprogrammingfinal 121011003536-phpapp02
Fundamentalsofprogrammingfinal 121011003536-phpapp02
thinesonsing
 

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

Christine's Product Research Presentation.pptx
Christine's Product Research Presentation.pptxChristine's Product Research Presentation.pptx
Christine's Product Research Presentation.pptx
christinelarrosa
 
A Deep Dive into ScyllaDB's Architecture
A Deep Dive into ScyllaDB's ArchitectureA Deep Dive into ScyllaDB's Architecture
A Deep Dive into ScyllaDB's Architecture
ScyllaDB
 
"What does it really mean for your system to be available, or how to define w...
"What does it really mean for your system to be available, or how to define w..."What does it really mean for your system to be available, or how to define w...
"What does it really mean for your system to be available, or how to define w...
Fwdays
 
inQuba Webinar Mastering Customer Journey Management with Dr Graham Hill
inQuba Webinar Mastering Customer Journey Management with Dr Graham HillinQuba Webinar Mastering Customer Journey Management with Dr Graham Hill
inQuba Webinar Mastering Customer Journey Management with Dr Graham Hill
LizaNolte
 
Dandelion Hashtable: beyond billion requests per second on a commodity server
Dandelion Hashtable: beyond billion requests per second on a commodity serverDandelion Hashtable: beyond billion requests per second on a commodity server
Dandelion Hashtable: beyond billion requests per second on a commodity server
Antonios Katsarakis
 
Apps Break Data
Apps Break DataApps Break Data
Apps Break Data
Ivo Velitchkov
 
GraphRAG for LifeSciences Hands-On with the Clinical Knowledge Graph
GraphRAG for LifeSciences Hands-On with the Clinical Knowledge GraphGraphRAG for LifeSciences Hands-On with the Clinical Knowledge Graph
GraphRAG for LifeSciences Hands-On with the Clinical Knowledge Graph
Neo4j
 
Leveraging the Graph for Clinical Trials and Standards
Leveraging the Graph for Clinical Trials and StandardsLeveraging the Graph for Clinical Trials and Standards
Leveraging the Graph for Clinical Trials and Standards
Neo4j
 
What is an RPA CoE? Session 1 – CoE Vision
What is an RPA CoE?  Session 1 – CoE VisionWhat is an RPA CoE?  Session 1 – CoE Vision
What is an RPA CoE? Session 1 – CoE Vision
DianaGray10
 
From Natural Language to Structured Solr Queries using LLMs
From Natural Language to Structured Solr Queries using LLMsFrom Natural Language to Structured Solr Queries using LLMs
From Natural Language to Structured Solr Queries using LLMs
Sease
 
QA or the Highway - Component Testing: Bridging the gap between frontend appl...
QA or the Highway - Component Testing: Bridging the gap between frontend appl...QA or the Highway - Component Testing: Bridging the gap between frontend appl...
QA or the Highway - Component Testing: Bridging the gap between frontend appl...
zjhamm304
 
Demystifying Knowledge Management through Storytelling
Demystifying Knowledge Management through StorytellingDemystifying Knowledge Management through Storytelling
Demystifying Knowledge Management through Storytelling
Enterprise Knowledge
 
zkStudyClub - LatticeFold: A Lattice-based Folding Scheme and its Application...
zkStudyClub - LatticeFold: A Lattice-based Folding Scheme and its Application...zkStudyClub - LatticeFold: A Lattice-based Folding Scheme and its Application...
zkStudyClub - LatticeFold: A Lattice-based Folding Scheme and its Application...
Alex Pruden
 
Crafting Excellence: A Comprehensive Guide to iOS Mobile App Development Serv...
Crafting Excellence: A Comprehensive Guide to iOS Mobile App Development Serv...Crafting Excellence: A Comprehensive Guide to iOS Mobile App Development Serv...
Crafting Excellence: A Comprehensive Guide to iOS Mobile App Development Serv...
Pitangent Analytics & Technology Solutions Pvt. Ltd
 
JavaLand 2024: Application Development Green Masterplan
JavaLand 2024: Application Development Green MasterplanJavaLand 2024: Application Development Green Masterplan
JavaLand 2024: Application Development Green Masterplan
Miro Wengner
 
LF Energy Webinar: Carbon Data Specifications: Mechanisms to Improve Data Acc...
LF Energy Webinar: Carbon Data Specifications: Mechanisms to Improve Data Acc...LF Energy Webinar: Carbon Data Specifications: Mechanisms to Improve Data Acc...
LF Energy Webinar: Carbon Data Specifications: Mechanisms to Improve Data Acc...
DanBrown980551
 
ScyllaDB Tablets: Rethinking Replication
ScyllaDB Tablets: Rethinking ReplicationScyllaDB Tablets: Rethinking Replication
ScyllaDB Tablets: Rethinking Replication
ScyllaDB
 
Main news related to the CCS TSI 2023 (2023/1695)
Main news related to the CCS TSI 2023 (2023/1695)Main news related to the CCS TSI 2023 (2023/1695)
Main news related to the CCS TSI 2023 (2023/1695)
Jakub Marek
 
Connector Corner: Seamlessly power UiPath Apps, GenAI with prebuilt connectors
Connector Corner: Seamlessly power UiPath Apps, GenAI with prebuilt connectorsConnector Corner: Seamlessly power UiPath Apps, GenAI with prebuilt connectors
Connector Corner: Seamlessly power UiPath Apps, GenAI with prebuilt connectors
DianaGray10
 
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
Jason Yip
 

Recently uploaded (20)

Christine's Product Research Presentation.pptx
Christine's Product Research Presentation.pptxChristine's Product Research Presentation.pptx
Christine's Product Research Presentation.pptx
 
A Deep Dive into ScyllaDB's Architecture
A Deep Dive into ScyllaDB's ArchitectureA Deep Dive into ScyllaDB's Architecture
A Deep Dive into ScyllaDB's Architecture
 
"What does it really mean for your system to be available, or how to define w...
"What does it really mean for your system to be available, or how to define w..."What does it really mean for your system to be available, or how to define w...
"What does it really mean for your system to be available, or how to define w...
 
inQuba Webinar Mastering Customer Journey Management with Dr Graham Hill
inQuba Webinar Mastering Customer Journey Management with Dr Graham HillinQuba Webinar Mastering Customer Journey Management with Dr Graham Hill
inQuba Webinar Mastering Customer Journey Management with Dr Graham Hill
 
Dandelion Hashtable: beyond billion requests per second on a commodity server
Dandelion Hashtable: beyond billion requests per second on a commodity serverDandelion Hashtable: beyond billion requests per second on a commodity server
Dandelion Hashtable: beyond billion requests per second on a commodity server
 
Apps Break Data
Apps Break DataApps Break Data
Apps Break Data
 
GraphRAG for LifeSciences Hands-On with the Clinical Knowledge Graph
GraphRAG for LifeSciences Hands-On with the Clinical Knowledge GraphGraphRAG for LifeSciences Hands-On with the Clinical Knowledge Graph
GraphRAG for LifeSciences Hands-On with the Clinical Knowledge Graph
 
Leveraging the Graph for Clinical Trials and Standards
Leveraging the Graph for Clinical Trials and StandardsLeveraging the Graph for Clinical Trials and Standards
Leveraging the Graph for Clinical Trials and Standards
 
What is an RPA CoE? Session 1 – CoE Vision
What is an RPA CoE?  Session 1 – CoE VisionWhat is an RPA CoE?  Session 1 – CoE Vision
What is an RPA CoE? Session 1 – CoE Vision
 
From Natural Language to Structured Solr Queries using LLMs
From Natural Language to Structured Solr Queries using LLMsFrom Natural Language to Structured Solr Queries using LLMs
From Natural Language to Structured Solr Queries using LLMs
 
QA or the Highway - Component Testing: Bridging the gap between frontend appl...
QA or the Highway - Component Testing: Bridging the gap between frontend appl...QA or the Highway - Component Testing: Bridging the gap between frontend appl...
QA or the Highway - Component Testing: Bridging the gap between frontend appl...
 
Demystifying Knowledge Management through Storytelling
Demystifying Knowledge Management through StorytellingDemystifying Knowledge Management through Storytelling
Demystifying Knowledge Management through Storytelling
 
zkStudyClub - LatticeFold: A Lattice-based Folding Scheme and its Application...
zkStudyClub - LatticeFold: A Lattice-based Folding Scheme and its Application...zkStudyClub - LatticeFold: A Lattice-based Folding Scheme and its Application...
zkStudyClub - LatticeFold: A Lattice-based Folding Scheme and its Application...
 
Crafting Excellence: A Comprehensive Guide to iOS Mobile App Development Serv...
Crafting Excellence: A Comprehensive Guide to iOS Mobile App Development Serv...Crafting Excellence: A Comprehensive Guide to iOS Mobile App Development Serv...
Crafting Excellence: A Comprehensive Guide to iOS Mobile App Development Serv...
 
JavaLand 2024: Application Development Green Masterplan
JavaLand 2024: Application Development Green MasterplanJavaLand 2024: Application Development Green Masterplan
JavaLand 2024: Application Development Green Masterplan
 
LF Energy Webinar: Carbon Data Specifications: Mechanisms to Improve Data Acc...
LF Energy Webinar: Carbon Data Specifications: Mechanisms to Improve Data Acc...LF Energy Webinar: Carbon Data Specifications: Mechanisms to Improve Data Acc...
LF Energy Webinar: Carbon Data Specifications: Mechanisms to Improve Data Acc...
 
ScyllaDB Tablets: Rethinking Replication
ScyllaDB Tablets: Rethinking ReplicationScyllaDB Tablets: Rethinking Replication
ScyllaDB Tablets: Rethinking Replication
 
Main news related to the CCS TSI 2023 (2023/1695)
Main news related to the CCS TSI 2023 (2023/1695)Main news related to the CCS TSI 2023 (2023/1695)
Main news related to the CCS TSI 2023 (2023/1695)
 
Connector Corner: Seamlessly power UiPath Apps, GenAI with prebuilt connectors
Connector Corner: Seamlessly power UiPath Apps, GenAI with prebuilt connectorsConnector Corner: Seamlessly power UiPath Apps, GenAI with prebuilt connectors
Connector Corner: Seamlessly power UiPath Apps, GenAI with prebuilt connectors
 
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
[OReilly Superstream] Occupy the Space: A grassroots guide to engineering (an...
 

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.