SlideShare une entreprise Scribd logo
1  sur  53
The Three Core Topic Types: Concept, Task, Reference ©  Marcia (Riefer Poulsen) Johnston  2006 [email_address]
To view in PowerPoint, press the F5 key (or in the menu bar go to  Slide Show  >  View Show ),  and click through the slides.
Thanks ,[object Object],[object Object],[object Object],[object Object]
Assumptions I’m making about you ,[object Object],[object Object],[object Object]
About me ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Why am I sharing what I’ve learned? ,[object Object],[object Object]
What we’ll cover ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
At the end, you’ll make this over. Isn’t this already in chunks?
What’s a topic? ,[object Object],[object Object],[object Object],[object Object],Hey, this slide is an example of a topic.
How does a topic stand alone? Art borrowed from an ArcSoft PhotoMontage ad ,[object Object],[object Object],[object Object],[object Object],Do We Really Need All that Glue? JoAnn Hackos on transitional text in topics http://dita.xml.org/node/1410
Why write in topics? ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
You don’t need these. ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
You can create topics with any tool. ,[object Object],[object Object],Aka topic-based writing
What are the core topic types? ,[object Object],Task Concept Reference Gives details of interest to certain readers, often in look-up lists or tables. Describes something.
Why  three  types (at least as a starting point)?  ,[object Object],[object Object],[object Object],[object Object]
Why call them  core  types? ,[object Object],[object Object]
What is DITA? ,[object Object],[object Object],[object Object],Information typing is DITA’s middle name.
Why structure topics by info type? ,[object Object],[object Object],[object Object],[object Object],Task Concept Reference
True or False? ,[object Object],[object Object],[object Object]
Fallacy: People don’t like to scroll down. ,[object Object],[object Object],This topic is longer becausy of all the steps required to This topic is longer becaush of all the steps required to This topic is longer becausm of all the steps required to About Widgets This paragraph is all it takes to describe the widget. So, this topic is short. Topic 1 This topic is longer because of all the steps required to This topic is longer becausc of all the steps required to This topic is longer becaust of all the steps required to Installing a Widget This topic is longer because of all the steps required. 1. Do this. 2. Do that. Topic 2
Fallacy: Hardcopy is linear, online is nonlinear. ,[object Object],[object Object],[object Object],[object Object],Topic C Topic X Topic M Chap 5 Chap 8 Chap 2
What elements make up topics? From  Introduction to DITA: A User Guide to the Darwin Information Typing Architecture Elements Topics Depends on your needs. Here’s one example: Mini building blocks
Concept topic — example 1 From  The Internet for Dummies,  2 nd  edition Elements Topic
Concept topics — example 2 Can be read in any order. From  Boys’ Life,  July 2006 Topic Topic Topic Topic Topic Topic Topic
Task topic — example 1 Elements Topic From Polaris ®  PowerPAC online help
Task topic — example 2 Setting Categories Elements Topic From FranklinCovey ®  planning software online help
Reference topic — example 1 Elements Topic From  The Internet for Dummies,  2 nd  edition Sidebar adjacent to other topics
Reference topic — example 2 Table tucked away in an appendix Topic Elements
Okay. I get it. How do I do it? ,[object Object],[object Object],[object Object],(≈ TOCs, playlists) I. Topic area a. Concept topic  b. Task topic II. Topic area Might look like an old-fashioned outline.
What makes a well-formed topic? ,[object Object],[object Object],[object Object]
4 characteristics of well-formed topics ,[object Object],[object Object],[object Object],[object Object],[object Object]
Well-formed topic — characteristic 1 ,[object Object]
Heading syntax — examples ,[object Object],[object Object],[object Object],[object Object],[object Object],XYZ  or  About XYZ What Is XYZ? Specifications Do You Need a Number   to Get a Name?
For more on verb forms in topic titles ,[object Object],[object Object]
Well-formed topic — characteristic 2 ,[object Object],[object Object],[object Object],[object Object]
Mixed info types — example This descriptive interruption goes on for another page before we reach step 6!  Concept info embedded  in task. Might want to keep bits of it here.
Well-formed topic — characteristic 3 ,[object Object],[object Object],[object Object]
How does a topic serve as a hub? ,[object Object],[object Object],[object Object],[object Object],How do we get from here   to Gate D25? Hub
Topics as hubs — example Task ABC 1. Do this. 2. Do that. Related Information Concept PQR Reference XYZ Concept PQR This explanation tells all about PQR. Related Information Task ABC Reference XYZ Reference XYZ Item Description Blah Blah blah blah Blah Blah blah blah Related Information Task ABC   Concept PQR Hub Hub Hub Kurt Ament calls such cross-references “cognitive bridges.”  Keep “Related Info” lists short and highly relevant.
Another way to talk about hubs ,[object Object],[object Object]
Well-formed topic — characteristic 4 ,[object Object],[object Object],[object Object],Minimalism
Let’s try some makeovers. ,[object Object],I did not make these up.
Makeover #1 — before ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Makeover #1 — after If a lead-in grows, you might spin it  off into its own concept topic.
Makeover #2 — before
Makeover #2 — after
Ideal:  Topics that stand alone AND read well in “browse sequence” You can jump to these topics in any order AND scroll from one to the next.
Your challenge: information modeling ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
Child’s play? ,[object Object],[object Object]
Books that discuss topic-based writing ,[object Object],[object Object],[object Object],[object Object],[object Object]
Recommended newsletter ,[object Object],[object Object],[object Object]
Excellent article ,[object Object],[object Object],[object Object]
Excellent free recorded webinars on DITA ,[object Object],[object Object]

Contenu connexe

Tendances

Domain Driven Design Development Spring Portfolio
Domain Driven Design Development Spring PortfolioDomain Driven Design Development Spring Portfolio
Domain Driven Design Development Spring PortfolioSrini Penchikala
 
The Netflix data platform: Now and in the future by Kurt Brown
The Netflix data platform: Now and in the future by Kurt BrownThe Netflix data platform: Now and in the future by Kurt Brown
The Netflix data platform: Now and in the future by Kurt BrownData Con LA
 
Time to Talk about Data Mesh
Time to Talk about Data MeshTime to Talk about Data Mesh
Time to Talk about Data MeshLibbySchulze
 
Data Architecture Strategies
Data Architecture StrategiesData Architecture Strategies
Data Architecture StrategiesDATAVERSITY
 
Agile Portfolio Management Framework With Demand Management
Agile Portfolio Management Framework With Demand ManagementAgile Portfolio Management Framework With Demand Management
Agile Portfolio Management Framework With Demand ManagementSlideTeam
 
An Introduction to Information Retrieval and Applications
 An Introduction to Information Retrieval and Applications An Introduction to Information Retrieval and Applications
An Introduction to Information Retrieval and Applications sathish sak
 
Enterprise architecture 101.36205348
Enterprise architecture 101.36205348Enterprise architecture 101.36205348
Enterprise architecture 101.36205348jamesoni1
 
Ibis: Seamless Transition Between Pandas and Apache Spark
Ibis: Seamless Transition Between Pandas and Apache SparkIbis: Seamless Transition Between Pandas and Apache Spark
Ibis: Seamless Transition Between Pandas and Apache SparkDatabricks
 
Near Real-Time Netflix Recommendations Using Apache Spark Streaming with Nit...
 Near Real-Time Netflix Recommendations Using Apache Spark Streaming with Nit... Near Real-Time Netflix Recommendations Using Apache Spark Streaming with Nit...
Near Real-Time Netflix Recommendations Using Apache Spark Streaming with Nit...Databricks
 
Master data management and data warehousing
Master data management and data warehousingMaster data management and data warehousing
Master data management and data warehousingZahra Mansoori
 
Data Architecture for Data Governance
Data Architecture for Data GovernanceData Architecture for Data Governance
Data Architecture for Data GovernanceDATAVERSITY
 
Spark + Parquet In Depth: Spark Summit East Talk by Emily Curtin and Robbie S...
Spark + Parquet In Depth: Spark Summit East Talk by Emily Curtin and Robbie S...Spark + Parquet In Depth: Spark Summit East Talk by Emily Curtin and Robbie S...
Spark + Parquet In Depth: Spark Summit East Talk by Emily Curtin and Robbie S...Spark Summit
 
Domain Driven Design (DDD)
Domain Driven Design (DDD)Domain Driven Design (DDD)
Domain Driven Design (DDD)Tom Kocjan
 
Doing Enterprise Architecture
Doing Enterprise ArchitectureDoing Enterprise Architecture
Doing Enterprise ArchitectureJohn Macasio
 
Apache Atlas: Tracking dataset lineage across Hadoop components
Apache Atlas: Tracking dataset lineage across Hadoop componentsApache Atlas: Tracking dataset lineage across Hadoop components
Apache Atlas: Tracking dataset lineage across Hadoop componentsDataWorks Summit/Hadoop Summit
 
Applying reference models with archi mate
Applying reference models with archi mateApplying reference models with archi mate
Applying reference models with archi mateBas van Gils
 

Tendances (20)

Solution architecture for big data projects
Solution architecture for big data projectsSolution architecture for big data projects
Solution architecture for big data projects
 
Taxonomy: Do I Need One
Taxonomy: Do I Need OneTaxonomy: Do I Need One
Taxonomy: Do I Need One
 
Domain Driven Design Development Spring Portfolio
Domain Driven Design Development Spring PortfolioDomain Driven Design Development Spring Portfolio
Domain Driven Design Development Spring Portfolio
 
The Netflix data platform: Now and in the future by Kurt Brown
The Netflix data platform: Now and in the future by Kurt BrownThe Netflix data platform: Now and in the future by Kurt Brown
The Netflix data platform: Now and in the future by Kurt Brown
 
Time to Talk about Data Mesh
Time to Talk about Data MeshTime to Talk about Data Mesh
Time to Talk about Data Mesh
 
Data Architecture Strategies
Data Architecture StrategiesData Architecture Strategies
Data Architecture Strategies
 
Enterprise Demand Management Framework
Enterprise Demand Management FrameworkEnterprise Demand Management Framework
Enterprise Demand Management Framework
 
Agile Portfolio Management Framework With Demand Management
Agile Portfolio Management Framework With Demand ManagementAgile Portfolio Management Framework With Demand Management
Agile Portfolio Management Framework With Demand Management
 
An Introduction to Information Retrieval and Applications
 An Introduction to Information Retrieval and Applications An Introduction to Information Retrieval and Applications
An Introduction to Information Retrieval and Applications
 
Optimize the IT Operating Model
Optimize the IT Operating ModelOptimize the IT Operating Model
Optimize the IT Operating Model
 
Enterprise architecture 101.36205348
Enterprise architecture 101.36205348Enterprise architecture 101.36205348
Enterprise architecture 101.36205348
 
Ibis: Seamless Transition Between Pandas and Apache Spark
Ibis: Seamless Transition Between Pandas and Apache SparkIbis: Seamless Transition Between Pandas and Apache Spark
Ibis: Seamless Transition Between Pandas and Apache Spark
 
Near Real-Time Netflix Recommendations Using Apache Spark Streaming with Nit...
 Near Real-Time Netflix Recommendations Using Apache Spark Streaming with Nit... Near Real-Time Netflix Recommendations Using Apache Spark Streaming with Nit...
Near Real-Time Netflix Recommendations Using Apache Spark Streaming with Nit...
 
Master data management and data warehousing
Master data management and data warehousingMaster data management and data warehousing
Master data management and data warehousing
 
Data Architecture for Data Governance
Data Architecture for Data GovernanceData Architecture for Data Governance
Data Architecture for Data Governance
 
Spark + Parquet In Depth: Spark Summit East Talk by Emily Curtin and Robbie S...
Spark + Parquet In Depth: Spark Summit East Talk by Emily Curtin and Robbie S...Spark + Parquet In Depth: Spark Summit East Talk by Emily Curtin and Robbie S...
Spark + Parquet In Depth: Spark Summit East Talk by Emily Curtin and Robbie S...
 
Domain Driven Design (DDD)
Domain Driven Design (DDD)Domain Driven Design (DDD)
Domain Driven Design (DDD)
 
Doing Enterprise Architecture
Doing Enterprise ArchitectureDoing Enterprise Architecture
Doing Enterprise Architecture
 
Apache Atlas: Tracking dataset lineage across Hadoop components
Apache Atlas: Tracking dataset lineage across Hadoop componentsApache Atlas: Tracking dataset lineage across Hadoop components
Apache Atlas: Tracking dataset lineage across Hadoop components
 
Applying reference models with archi mate
Applying reference models with archi mateApplying reference models with archi mate
Applying reference models with archi mate
 

En vedette

Doc Book Vs Dita Teresa
Doc Book Vs Dita TeresaDoc Book Vs Dita Teresa
Doc Book Vs Dita Teresaday
 
Distribution And Consumpion of Minerals
Distribution And Consumpion of MineralsDistribution And Consumpion of Minerals
Distribution And Consumpion of MineralsJulius Vincent Salon
 
Mila Angelova: Making the Core Inventory work
Mila Angelova: Making the Core Inventory workMila Angelova: Making the Core Inventory work
Mila Angelova: Making the Core Inventory workeaquals
 
Energy sources.ppt
Energy sources.pptEnergy sources.ppt
Energy sources.pptambikarockss
 
Introduction To Docbook 4 .5 Authoring
Introduction To Docbook 4 .5   AuthoringIntroduction To Docbook 4 .5   Authoring
Introduction To Docbook 4 .5 AuthoringViswanath J
 
Minerals and energy resources
Minerals and energy resourcesMinerals and energy resources
Minerals and energy resourcesAditya Raghav
 
Mineral and energy resources
Mineral and energy resourcesMineral and energy resources
Mineral and energy resourcesShivanshu Gupta
 
Casting and its types
Casting and its typesCasting and its types
Casting and its typesWaqas Ahmed
 

En vedette (14)

Doc Book Vs Dita Teresa
Doc Book Vs Dita TeresaDoc Book Vs Dita Teresa
Doc Book Vs Dita Teresa
 
Flowcharting DITA
Flowcharting DITAFlowcharting DITA
Flowcharting DITA
 
Mining the Methods: A Mind the App Playshop
Mining the Methods: A Mind the App PlayshopMining the Methods: A Mind the App Playshop
Mining the Methods: A Mind the App Playshop
 
Distribution And Consumpion of Minerals
Distribution And Consumpion of MineralsDistribution And Consumpion of Minerals
Distribution And Consumpion of Minerals
 
Mila Angelova: Making the Core Inventory work
Mila Angelova: Making the Core Inventory workMila Angelova: Making the Core Inventory work
Mila Angelova: Making the Core Inventory work
 
Energy sources.ppt
Energy sources.pptEnergy sources.ppt
Energy sources.ppt
 
DITA Quick Start
DITA Quick StartDITA Quick Start
DITA Quick Start
 
Introduction To Docbook 4 .5 Authoring
Introduction To Docbook 4 .5   AuthoringIntroduction To Docbook 4 .5   Authoring
Introduction To Docbook 4 .5 Authoring
 
Minerals and energy resources
Minerals and energy resourcesMinerals and energy resources
Minerals and energy resources
 
Mineral and energy resources
Mineral and energy resourcesMineral and energy resources
Mineral and energy resources
 
casting ppt
casting pptcasting ppt
casting ppt
 
Metal casting process
Metal casting processMetal casting process
Metal casting process
 
Mineral Resources
Mineral ResourcesMineral Resources
Mineral Resources
 
Casting and its types
Casting and its typesCasting and its types
Casting and its types
 

Similaire à The Three Core Topic Types

Topic based and structured authoring - slides
Topic based and structured authoring - slidesTopic based and structured authoring - slides
Topic based and structured authoring - slidesNeil Perlin
 
Topic based and structured authoring - slides
Topic based and structured authoring - slidesTopic based and structured authoring - slides
Topic based and structured authoring - slidesNeil Perlin
 
Topic-oriented writing at McAfee
Topic-oriented writing at McAfeeTopic-oriented writing at McAfee
Topic-oriented writing at McAfeeJohn Sarr
 
Painless XML Authoring?: How DITA Simplifies XML
Painless XML Authoring?: How DITA Simplifies XMLPainless XML Authoring?: How DITA Simplifies XML
Painless XML Authoring?: How DITA Simplifies XMLScott Abel
 
Single sourcing to the max
Single sourcing to the maxSingle sourcing to the max
Single sourcing to the maxNeil Perlin
 
Dita for the web: Make Adaptive Content Simple for Writers and Developer
Dita for the web: Make Adaptive Content Simple for Writers and DeveloperDita for the web: Make Adaptive Content Simple for Writers and Developer
Dita for the web: Make Adaptive Content Simple for Writers and DeveloperDon Day
 
Writing every page is page one topics
Writing every page is page one topics Writing every page is page one topics
Writing every page is page one topics Mark Baker
 
Structured design: Modular style for modern content
Structured design: Modular style for modern contentStructured design: Modular style for modern content
Structured design: Modular style for modern contentChristopher Hess
 
Modular Documentation Joe Gelb Techshoret 2009
Modular Documentation Joe Gelb Techshoret 2009Modular Documentation Joe Gelb Techshoret 2009
Modular Documentation Joe Gelb Techshoret 2009Suite Solutions
 
DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016
DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016
DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016IXIASOFT
 
Multigenre Project Guidelines Rust Fall 2014
Multigenre Project Guidelines Rust Fall 2014 Multigenre Project Guidelines Rust Fall 2014
Multigenre Project Guidelines Rust Fall 2014 Buffy Hamilton
 
Multilayered paper prototyping for user concept modeling
Multilayered paper prototyping for user concept modelingMultilayered paper prototyping for user concept modeling
Multilayered paper prototyping for user concept modelingUKOLN (dev), University of Bath
 
Chunking and storyboarding
Chunking and storyboardingChunking and storyboarding
Chunking and storyboardingNelly Kamel
 
Developing for the unknown lavacon
Developing for the unknown   lavaconDeveloping for the unknown   lavacon
Developing for the unknown lavaconNeil Perlin
 
Developing for the unknown lavacon
Developing for the unknown   lavaconDeveloping for the unknown   lavacon
Developing for the unknown lavaconNeil Perlin
 
1. introduction to data science —
1. introduction to data science —1. introduction to data science —
1. introduction to data science —swethaT16
 
Structuring Information Before DITA
Structuring Information Before DITAStructuring Information Before DITA
Structuring Information Before DITASteven Jong
 
Lotusphere 2007 AD507 Leveraging the Power of Object Oriented Programming in ...
Lotusphere 2007 AD507 Leveraging the Power of Object Oriented Programming in ...Lotusphere 2007 AD507 Leveraging the Power of Object Oriented Programming in ...
Lotusphere 2007 AD507 Leveraging the Power of Object Oriented Programming in ...Bill Buchan
 

Similaire à The Three Core Topic Types (20)

Topic based and structured authoring - slides
Topic based and structured authoring - slidesTopic based and structured authoring - slides
Topic based and structured authoring - slides
 
Topic based and structured authoring - slides
Topic based and structured authoring - slidesTopic based and structured authoring - slides
Topic based and structured authoring - slides
 
Topic-oriented writing at McAfee
Topic-oriented writing at McAfeeTopic-oriented writing at McAfee
Topic-oriented writing at McAfee
 
Painless XML Authoring?: How DITA Simplifies XML
Painless XML Authoring?: How DITA Simplifies XMLPainless XML Authoring?: How DITA Simplifies XML
Painless XML Authoring?: How DITA Simplifies XML
 
Single sourcing to the max
Single sourcing to the maxSingle sourcing to the max
Single sourcing to the max
 
Dita for the web: Make Adaptive Content Simple for Writers and Developer
Dita for the web: Make Adaptive Content Simple for Writers and DeveloperDita for the web: Make Adaptive Content Simple for Writers and Developer
Dita for the web: Make Adaptive Content Simple for Writers and Developer
 
Ad507
Ad507Ad507
Ad507
 
Writing every page is page one topics
Writing every page is page one topics Writing every page is page one topics
Writing every page is page one topics
 
Structured design: Modular style for modern content
Structured design: Modular style for modern contentStructured design: Modular style for modern content
Structured design: Modular style for modern content
 
Modular Documentation Joe Gelb Techshoret 2009
Modular Documentation Joe Gelb Techshoret 2009Modular Documentation Joe Gelb Techshoret 2009
Modular Documentation Joe Gelb Techshoret 2009
 
DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016
DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016
DITA Surprise, Unwrapping DITA Best Practices - tekom tcworld 2016
 
Multigenre Project Guidelines Rust Fall 2014
Multigenre Project Guidelines Rust Fall 2014 Multigenre Project Guidelines Rust Fall 2014
Multigenre Project Guidelines Rust Fall 2014
 
Multilayered paper prototyping for user concept modeling
Multilayered paper prototyping for user concept modelingMultilayered paper prototyping for user concept modeling
Multilayered paper prototyping for user concept modeling
 
Chunking and storyboarding
Chunking and storyboardingChunking and storyboarding
Chunking and storyboarding
 
Developing for the unknown lavacon
Developing for the unknown   lavaconDeveloping for the unknown   lavacon
Developing for the unknown lavacon
 
Developing for the unknown lavacon
Developing for the unknown   lavaconDeveloping for the unknown   lavacon
Developing for the unknown lavacon
 
The Road to DITA
The Road to DITAThe Road to DITA
The Road to DITA
 
1. introduction to data science —
1. introduction to data science —1. introduction to data science —
1. introduction to data science —
 
Structuring Information Before DITA
Structuring Information Before DITAStructuring Information Before DITA
Structuring Information Before DITA
 
Lotusphere 2007 AD507 Leveraging the Power of Object Oriented Programming in ...
Lotusphere 2007 AD507 Leveraging the Power of Object Oriented Programming in ...Lotusphere 2007 AD507 Leveraging the Power of Object Oriented Programming in ...
Lotusphere 2007 AD507 Leveraging the Power of Object Oriented Programming in ...
 

Plus de Marcia Riefer Johnston

Plus de Marcia Riefer Johnston (9)

Write Tighter: Get to the Point and Save Millions
Write Tighter: Get to the Point and Save MillionsWrite Tighter: Get to the Point and Save Millions
Write Tighter: Get to the Point and Save Millions
 
Teach Your Text to Strip: Take It Off—Take It (Almost) All Off
Teach Your Text to Strip: Take It Off—Take It (Almost) All OffTeach Your Text to Strip: Take It Off—Take It (Almost) All Off
Teach Your Text to Strip: Take It Off—Take It (Almost) All Off
 
"Write Tight(er)"—LavaCon, Oct 12, 2014
"Write Tight(er)"—LavaCon, Oct 12, 2014"Write Tight(er)"—LavaCon, Oct 12, 2014
"Write Tight(er)"—LavaCon, Oct 12, 2014
 
Write Tight(er)—STC Spectrum14
Write Tight(er)—STC Spectrum14Write Tight(er)—STC Spectrum14
Write Tight(er)—STC Spectrum14
 
We Are All Abbott and Costello
We Are All Abbott and CostelloWe Are All Abbott and Costello
We Are All Abbott and Costello
 
Write Tight(er) 12-01-2013
Write Tight(er) 12-01-2013Write Tight(er) 12-01-2013
Write Tight(er) 12-01-2013
 
Single Sourcing With FrameMaker
Single Sourcing With FrameMakerSingle Sourcing With FrameMaker
Single Sourcing With FrameMaker
 
Google Desktop searching
Google Desktop searchingGoogle Desktop searching
Google Desktop searching
 
Procedure Writing
Procedure WritingProcedure Writing
Procedure Writing
 

The Three Core Topic Types

  • 1. The Three Core Topic Types: Concept, Task, Reference © Marcia (Riefer Poulsen) Johnston 2006 [email_address]
  • 2. To view in PowerPoint, press the F5 key (or in the menu bar go to Slide Show > View Show ), and click through the slides.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8. At the end, you’ll make this over. Isn’t this already in chunks?
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22. What elements make up topics? From Introduction to DITA: A User Guide to the Darwin Information Typing Architecture Elements Topics Depends on your needs. Here’s one example: Mini building blocks
  • 23. Concept topic — example 1 From The Internet for Dummies, 2 nd edition Elements Topic
  • 24. Concept topics — example 2 Can be read in any order. From Boys’ Life, July 2006 Topic Topic Topic Topic Topic Topic Topic
  • 25. Task topic — example 1 Elements Topic From Polaris ® PowerPAC online help
  • 26. Task topic — example 2 Setting Categories Elements Topic From FranklinCovey ® planning software online help
  • 27. Reference topic — example 1 Elements Topic From The Internet for Dummies, 2 nd edition Sidebar adjacent to other topics
  • 28. Reference topic — example 2 Table tucked away in an appendix Topic Elements
  • 29.
  • 30.
  • 31.
  • 32.
  • 33.
  • 34.
  • 35.
  • 36. Mixed info types — example This descriptive interruption goes on for another page before we reach step 6! Concept info embedded in task. Might want to keep bits of it here.
  • 37.
  • 38.
  • 39. Topics as hubs — example Task ABC 1. Do this. 2. Do that. Related Information Concept PQR Reference XYZ Concept PQR This explanation tells all about PQR. Related Information Task ABC Reference XYZ Reference XYZ Item Description Blah Blah blah blah Blah Blah blah blah Related Information Task ABC Concept PQR Hub Hub Hub Kurt Ament calls such cross-references “cognitive bridges.” Keep “Related Info” lists short and highly relevant.
  • 40.
  • 41.
  • 42.
  • 43.
  • 44. Makeover #1 — after If a lead-in grows, you might spin it off into its own concept topic.
  • 45. Makeover #2 — before
  • 47. Ideal: Topics that stand alone AND read well in “browse sequence” You can jump to these topics in any order AND scroll from one to the next.
  • 48.
  • 49.
  • 50.
  • 51.
  • 52.
  • 53.

Notes de l'éditeur

  1. REUSE: Maximized if using CMS. Limited in Word, FrameMaker, etc. Example: Easy to reuse same chapter in different Frame books. Might reuse topics by importing them. Might reuse smaller elements using cross-references. Not ideal. TRANSLATION: (1) Can send topics for translation as they're approved vs. waiting for a whole document to be approved. Doesn't save costs, but reduces wait time. (2) Since topics make sense in any context, they can be reused without any tweaking in any language. (3) Easier to update translated text in standalone topics.
  2. Thanks to Mark Baker in the Single Sourcing SIG, and to online Help expert Neil Perlin, for helpful discussions on these questions. Some customized topics that people have mentioned: planning methods facts processes principles troubleshooting Show-Me demos
  3. JoAnn Hackos 9/8/06 response to a query posted by a single-sourcing SIG member : “ These components (methods, methodology, results, findings, conclusions, and recommendations) are standard parts of research reports everywhere. One of our clients, The Research Foundation of the American Waterworks Association, uses exactly the same format, as do most research organizations. It would be worthwhile to consider a DITA subcommittee on a research report specialization. Perhaps the specialization would not have to be structural , in that the generic topic might work well structurally. Remember that the generic topic is closest to the concept information type. However, it seems that research reports might require a domain specialization, which means developing specific semantics in the form of XML tags and possibly metadata categories that would assist in properly labeling content in the reports.”