Ibm Press Ser.: DITA Best Practices : A Roadmap for Writing, Editing, and Architecting in DITA by Jenifer Schlotfeldt, Laura Bellamy and Michelle Carey (2011, Trade Paperback)

Brenham Book Company (1340)
94.6% positive feedback
Price:
$155.83
+ $4.25 shipping
Estimated delivery Fri, Nov 14 - Thu, Nov 20
Returns:
30 days returns. Buyer pays for return shipping. If you use an eBay shipping label, it will be deducted from your refund amount.
Condition:
Brand New
Take $10.00 off this item
Ends 11 NovSee details
What should you know up front?. How can you avoid those pitfalls?. Also see the other books in this IBM Press series: Developing Quality Technical Information: A Handbook for Writers and Editors The IBM Style Guide: Conventions for Writers and Editors.

About this product

Product Identifiers

PublisherPearson Education
ISBN-100132480522
ISBN-139780132480529
eBay Product ID (ePID)102846336

Product Key Features

Number of Pages304 Pages
LanguageEnglish
Publication NameDita Best Practices : a Roadmap for Writing, Editing, and Architecting in Dita
SubjectDesktop Applications / Desktop Publishing, Technical Writing
Publication Year2011
FeaturesRevised
TypeTextbook
Subject AreaComputers, Technology & Engineering
AuthorJenifer Schlotfeldt, Laura Bellamy, Michelle Carey
SeriesIbm Press Ser.
FormatTrade Paperback

Dimensions

Item Height0.8 in
Item Weight16 Oz
Item Length9 in
Item Width6.9 in

Additional Product Features

Intended AudienceScholarly & Professional
LCCN2011-035337
Dewey Edition23
IllustratedYes
Dewey Decimal808.06/66
Table Of ContentAcknowledgments xviii About the Authors xx Introduction 1 PART I: WRITING IN DITA 5 Chapter 1 Topic-Based Writing in DITA 7 Books, Topics, and Webs of Information 7 Advantages of Writing in Topics for Writing Teams 9 Writers Can Work More Productively 9 Writers Can Share Content with Other Writers 9 Writers Can Reuse Topics 10 Writers Can More Quickly Organize or Reorganize Content 10 Reviewers Can Review Small Groups of Topics Instead of Long Books 10 DITA Topic Types 10 Task Orientation 12 Task Analysis 13 Minimalist Writing 16 Know Your Audience 16 Remove Nonessential Content 16 Focus on User Goals, Not Product Functions 16 To Wrap Up 17 Topic-Based Writing Checklist 18 Task analysis form 19 Chapter 2 Task Topics 21 Separate Task Information from Conceptual or Reference Information 22 Write One Procedure per Topic 22 Create Subtasks to Organize Long Procedures 22 Task Components and DITA Elements 23 Titling the Task: 24 Introducing the Task: 25 Adding More Background Information: 25 Describing Prerequisites: 26 Writing the Procedure: and 28 Concluding the Task: , , and 35 Task Topic Checklist 39 Chapter 3 Concept Topics 41 Describe One Concept per Topic 42 Create a Concept Topic Only if the Idea Can''t Be Covered More Concisely Elsewhere 42 Separate Task Information from Conceptual Information 42 Concept Components and DITA Elements 43 Titling the Concept Topic: 43 Introducing the Concept Topic: 44 Writing the Concept: 44 Organizing the Concept: 44 Adding Lists: , , , and 45 Including Graphics: , , and 48 Highlighting New Terms: 48 To Wrap Up 49 Concept Topic Checklist 50 Chapter 4 Reference Topics 51 Describe One Type of Reference Material per Topic 51 Organize Reference Information Effectively 52 Format Reference Information Consistently 52 Reference Components and DITA Elements 52 Titling the Reference topic: 53 Introducing the Reference Information: 54 Organizing the Reference Information: 54 Creating Tables: , , and 56 Adding Lists: and 58 Creating Syntax Diagrams: and 59 To Wrap Up 60 Chapter 5 Short Descriptions 63 The Element 63 How the Short Description Is Used 63 Guidelines for Writing Effective Short Descriptions 66 Briefly State the Purpose of the Topic 67 Include a Short Description in Every Topic 68 Use Complete, Grammatical Sentences 69 Don''t Introduce Lists, Figures, or Tables 70 Keep Short Descriptions Short 71 Short Descriptions for Task, Concept, and Reference Topics 75 Task Topic Short Descriptions 75 Concept Topic Short Descriptions 79 Reference Topic Short Descriptions 80 Writing Short Descriptions for Converted Content 81 The Element 81 Using More DITA Elements in the Topic Introduction 82 Including Multiple Short Descriptions 83 To Wrap Up 84 Short Description Examples 85 Short Description Checklist 87 PART II: ARCHITECTING CONTENT 89 Chapter 6 DITA Maps and Navigation 91 DITA Map Structure 91 Relationships Between Topics 92 Information Organization 92 Information Modeling 96 Benefits of Information Modeling 96 Building Information Models 97 Bookmaps 97 Submaps 98 DITA Map Ownership 101 Include Relationship Tables in DITA Maps 101 Override Topic Titles and Short Descriptions 102 Navigation Titles 102 Short Descriptions 102 Provide Unique Short Descriptions for Reused Topics 103 Provide Short Descriptions for Links to Non-DITA Content 105 Suppressing Topics from the Table of Contents Suppressing Content from PDF Output 106 Suppressing Content from HTML Output 107 To Wrap Up
Edition DescriptionRevised edition
Synopsis&>The Start-to-Finish, Best-Practice Guide to Implementing and Using DITA Darwin Information Typing Architecture (DITA) is today's most powerful toolbox for constructing information. By implementing DITA, organizations can gain more value from their technical documentation than ever before. Now, three DITA pioneers offer the first complete roadmap for successful DITA adoption, implementation, and usage. Drawing on years of experience helping large organizations adopt DITA, the authors answer crucial questions the "official" DITA documents ignore, including: Where do you start? What should you know up front? What are the pitfalls in implementing DITA? How can you avoid those pitfalls? The authors begin with topic-based writing, presenting proven best practices for developing effective topics and short descriptions. Next, they address content architecture, including how best to set up and implement DITA maps, linking strategies, metadata, conditional processing, and content reuse. Finally, they offer "in the trenches" solutions for ensuring quality implementations, including guidance on content conversion. Coverage includes: Knowing how and when to use each DITA element-and when not to Writing "minimalist," task-oriented information that quickly meets users' needs Creating effective task, concept, and reference topics for any product, technology, or service Writing effective short descriptions that work well in all contexts Structuring DITA maps to bind topics together and provide superior navigation Using links to create information webs that improve retrievability and navigation Gaining benefits from metadata without getting lost in complexity Using conditional processing to eliminate redundancy and rework Systematically promoting reuse to improve quality and reduce costs Planning, resourcing, and executing effective content conversion Improving quality by editing DITA content and XML markup If you're a writer, editor, information architect, manager, or consultant who evaluates, deploys, or uses DITA, this book will guide you all the way to success. Also see the other books in this IBM Press series: Developing Quality Technical Information: A Handbook for Writers and Editors The IBM Style Guide: Conventions for Writers and Editors
LC Classification NumberQA76.76.H94B45 2012

All listings for this product

Buy It Nowselected
Any Conditionselected
New
Pre-owned
No ratings or reviews yet
Be the first to write a review