Author: Mark Baker
Publisher: XML Press
Release Date: 2013-12-03
The Web changes how people use content; not just content on the Web, but all content. If your content is not easy to find and immediately helpful, readers will move on almost at once. We are all children of the Web, and we come to any information system, including product documentation, looking for the search box and expecting every search to work like Google. There is no first, last, previous, next, up, or back anymore. Every Page is Page One. In this ground-breaking book, Mark Baker looks beyond the usual advice on writing for the Web, and beyond the idea of topic-based writing merely as an aid to efficiency and reuse, to explore how readers really use information in the age of the Web and to lay out an approach to planning, creating, managing, and organizing topic-based documentation that really works for the reader.
The #1 Guide to Excellence in Technical Communication—Fully Updated for Embedded Assistance, Mobile, Search, Multimedia, and More Direct from IBM’s own content design experts, this guide shows you how to design product interfaces and technical information that always place users front and center. This edition has been fully revised to help you consistently deliver the right content at the right time. You’ll master today’s best practices to apply nine essential characteristics of high-quality technical information: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness. Coverage Includes Advocating for users throughout the entire product development process Delivering information in an ordered manner by following progressive disclosure techniques Optimizing content so that users can find it from anywhere Streamlining information for mobile delivery Helping users right where they are Whether you’re a writer, editor, information architect, user experience professional, or reviewer, this book shows you how to create great technical information, from the product design to the user interface, topics, and other media. Thoroughly revised and updated Extensive new coverage of self-documenting interfaces and embedded assistance Updated practical guidelines and checklists Hundreds of new examples
Author: John Millar Carroll
Publisher: MIT Press
Release Date: 1998-01
Minimalism is an action- and task-oriented approach to instruction and documentation that emphasizes the importance of realistic activities and experiences for effective learning and information seeking. Since 1990, when the approach was defined in John Carroll's The Nurnberg Funnel, much work has been done to apply, refine, and broaden the minimalist approach to technical communication. This volume presents fourteen major contributions to the current theory and practice of minimalism. Contributors evaluate the development of minimalism up to now, analyze the acceptance of minimalism by the mainstream technical communications community, report on specific innovations and investigations, and discuss future challenges and directions. The book also includes an appendix containing a bibliography of published research and development work on minimalism since 1990. Contributors: Tricia Anson, R. John Brockmann, John M. Carroll, Steve Draper, David K. Farkas, JoAnn T. Hackos, Robert R. Johnson, Greg Kearsley, Barbara Mirel, Janice (Ginny) Redish, Stephanie Rosenbaum, Karl L. Smart, Hans van der Meij. Published in association with the Society for Technical Communication .
"Learn how to have great conversations through your site or app. Meet your business goals while satisfying your site visitors' needs. Learn how to create useful and usable content from the master - Ginny Redish. Ginny's easy-to-read style will teach you how to plan, organize, write, design, and test your content"--
Veterinary medicine has long been recognized as one of the more neglected areas of medical history. One of the main stumbling blocks to research is the lack of comprehensive information regarding the survival and availability of primary source material. Veterinary Medicine: A Guide to Historical Sources redresses these issues for the first time, offering researchers an unparalleled tool with which to approach the subject. The book opens with a brief history of veterinary medicine and the veterinary profession from the fourteenth to the beginning of the twenty first centuries, identifying the key dates and events that shaped their development. There then follows a chapter on the nature and uses of the records covered by the book, outlining the types of records found, the type of information they contain and their likely uses by different types of researcher. A brief user's guide then explains how to use the book. After these preliminary sections, comes the main body of the book, the lists of records. It is here that the various practices and institutions covered by the book are listed, together with the types of records they hold, the dates they cover and where they are kept. A short biographical history is also included with each entry where appropriate. Taken as a whole this volume will prove to be an invaluable aid for any scholar, researching the history of veterinary medicine in Britain.
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
Author: Anne Gentle
Publisher: XML Press
Release Date: 2012-07-15
Anne Gentle's Conversation and Community has become the go-to reference for social media and technical communication. Her clear-eyed survey of the social media landscape has been adopted by many universities and is widely used by technical communicators. Now, in this second edition, she has updated and expanded her book, adding chapters on building a content strategy, analyzing web techniques, and developing an open source strategy. With more interviews and case studies, this is your guide to the new world of technical communication and social media. Inside the Book Towards the Future of Documentation Defining a Writer's Role with the Social Web Community and Documentation Commenting and Connecting with Users Wikis as Documentation Systems Finding Your Voice Content Strategy for Community Documentation NEW Chapter Analyzing and Measuring Web Techniques NEW Chapter Open Source Documentation NEW Chapter Concepts and Tools of the Social Web Glossary, Expanded Bibliography, and Index
Author: Paul V. Anderson
Publisher: Cengage Learning
Release Date: 2016-12-05
Genre: Language Arts & Disciplines
Faculty have used Anderson's TECHNICAL COMMUNICATION: A READER-CENTERED APPROACH to prepare thousands of students for the writing they will do in their careers. Known for its rhetorical treatment of workplace writing and speaking, this text helps students learn practical, flexible strategies for creating useful and persuasive communications on the job. Reorganized and streamlined to enhance student learning, the ninth edition includes greatly expanded attention to social media. It also introduces to technical communication pedagogy a set of exercises and instruction that help students transfer their technical communication knowledge and skills from school to workplace. Important Notice: Media content referenced within the product description or the product text may not be available in the ebook version.
The #1 guide to creating effective online documentation is now updated and expanded to reflect the latest technological advances, including multimedia. "...online documentation is a different medium, as different from books as television is from radio or movies from novels. This edition treats online documentation as the new electronic medium it is." -William Horton Written by an internationally renowned pioneer in the field of technical communication, this is an incomparable guide to the art and science of creating online documents and documentation systems. Rather than concentrating on any one particular program or operating system, William Horton cuts to the heart of effective human-computer interaction and extrapolates a set of universal principles that can be applied to any form of online documentation-from messages, menus, and help files, to computer tutorials and hypertexts. Maintaining an end-user's perspective throughout, he guides you step by step through every crucial design decision without ever losing sight of the final goal-clear, effective online documentation that people enjoy using. Proven techniques that help reduce support and training costs for software products, eliminate the need for paper documentation, make programs more appealing and easier to use, and more * A practical, hands-on approach, supported by the latest research and supplemented with dozens of case studies and illustrations * Includes new chapters on multimedia and computer-based training * Comprehensive coverage of all online documentation media-words, graphics, animation, and sound * Updated information on organizing and structuring documents-with examples from Windows, OS/2, and Macintosh interfaces
Author: Leigh W. White
Publisher: XML Press
Release Date: 2017-02-16
As DITA has become more and more popular, demand has increased for tools thatcan provide high quality PDFs from DITA content. The DITA Open Toolkit providesa basic PDF capability, but nearly any real-world application will require customization.Leigh White's book, DITA for Print has become the go-to reference for building aprint customization plugin for the DITA Open Toolkit. This second edition coversOpen Toolkit, version 2, including customizing the DITA 1.3 troubleshooting topictype, localization strings, bookmarks, and the new back-cover functionality.DITA for Print is for anyone who wants to learn how to create PDFs using the DITAOpen Toolkit without learning everything there is to know about XSL-FO, XSLT, orXPath, or even about the DITA Open Toolkit itself. DITA for Print is written for nonprogrammers,by a non-programmer, and although it is written for people who have agood understanding of the DITA standard, you don't need a technical background toget custom PDFs up and running quickly.
Author: Johndan Johnson-Eilola
Publisher: University of Chicago Press
Release Date: 2012-12-26
The field of technical communication is rapidly expanding in both the academic world and the private sector, yet a problematic divide remains between theory and practice. Here Stuart A. Selber and Johndan Johnson-Eilola, both respected scholars and teachers of technical communication, effectively bridge that gap. Solving Problems in Technical Communication collects the latest research and theory in the field and applies it to real-world problems faced by practitioners—problems involving ethics, intercultural communication, new media, and other areas that determine the boundaries of the discipline. The book is structured in four parts, offering an overview of the field, situating it historically and culturally, reviewing various theoretical approaches to technical communication, and examining how the field can be advanced by drawing on diverse perspectives. Timely, informed, and practical, Solving Problems in Technical Communication will be an essential tool for undergraduates and graduate students as they begin the transition from classroom to career.
Author: Kirk St Amant
Publisher: Taylor & Francis
Release Date: 2017-07-05
The increasingly global nature of the World Wide Web presents new challenges and opportunities for technical communicators who must develop content for clients or colleagues from other cultures and in other nations. As international online access grows, technical communicators will encounter a range of challenges related to culture and communication in cyberspace. These challenges include how to design content and develop services for online distribution to a culturally diverse audience of users; how to address cultural and linguistic factors effectively when collaborating with international colleagues and clients via online media; and how to develop effective online teaching and training practices and materials for use in learning environments comprised of culturally diverse groups of students. The contributors to Culture, Communication and Cyberspace examine these challenges through chapters that explore the different aspects of international online communication. The contributing authors use a range of methodologies to review a variety of topics related to culture and communication in cyberspace. In so doing, the authors also examine how business trends, such as international outsourcing, content management, and the use of open source software (OSS), are affecting and could change practices in the field of technical communication as related to online cross-cultural interactions.
Publisher: U.S. Government Printing Office
Release Date: 2006
Although recent findings show the public increasingly interacting with government Web sites, a common problem is that people can’t find what they’re looking for. In other words, the sites lack usability. The Research-Based Web Design and Usability Guidelines aid in correcting this problem by providing the latest Web design guidance from the research and other forms of evidence. This unique publication has been updated from its earlier version to include over 40 new or updated research guidelines, bringing the total to 209. Primary audiences for the book are: Web managers, designers, and all staff involved in the creation of Web sites. Topics in the book include: home page design, page and site navigation, graphics and images, effective Web content writing, and search. A new section on usability testing guidance has been added. Experts from across government, industry, and academia have reviewed and contributed to the development of the Guidelines. And, since their introduction in 2003, the Guidelines have been widely used by government, private, and academic institutions to improve Web design.
Surveys the online social habits of American teens and analyzes the role technology and social media plays in their lives, examining common misconceptions about such topics as identity, privacy, danger, and bullying.