Designing and Writing Online Documentation

Designing and Writing Online Documentation
Author: William Horton
Publisher:
Total Pages: 472
Release: 1994-11-07
Genre: Computers
ISBN:

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

Designing and Writing Online Documentation

Designing and Writing Online Documentation
Author: William Horton
Publisher: New York : Wiley
Total Pages: 392
Release: 1990-01-16
Genre: Computers
ISBN:

This guide shows how to design documents for rapid retrieval and display of stored information. Uses a step-by-step, hands-on approach, covering all the major design decisions involved in creating effective online documentation systems. Draws on actual experience backed by academic research to set forth design principles underlying effective human-computer interaction. Includes hundreds of examples showing how to design and create messages, menus, help files, computer tutorials, bibliographic databases, and hypertext.

Human-Computer Interaction

Human-Computer Interaction
Author: Julie A. Jacko
Publisher: CRC Press
Total Pages: 1345
Release: 2003-09-01
Genre: Technology & Engineering
ISBN: 0805849300

This four volume set provides the complete proceedings of the 10th International Conference on Human-Computer Interaction held June, 2003 in Crete, Greece. A total of 2,986 individuals from industry, academia, research institutes, and governmental agencies from 59 countries submitted their work for presentation at the conference. The papers address the latest research and development efforts, as well as highlight the human aspects of design and use of computing systems. Those accepted for presentation thoroughly cover the entire field of human-computer interaction, including the cognitive, social, ergonomic, and health aspects of work with computers. The papers also address major advances in knowledge and effective use of computers in a variety of diversified application areas, including offices, financial institutions, manufacturing, electronic publishing, construction, health care, and disabled and elderly people.

Docs Like Code

Docs Like Code
Author: Anne Gentle
Publisher: Lulu.com
Total Pages: 118
Release: 2017-09-09
Genre: Computers
ISBN: 1387081322

Looking for a way to invigorate your technical writing team and grow that expertise to include developers, designers, and writers of all backgrounds? When you treat docs like code, you multiply everyone's efforts and streamline processes through collaboration, automation, and innovation. Second edition now available with updates and more information about version control for documents and continuous publishing.

Microsoft Manual of Style

Microsoft Manual of Style
Author: Microsoft Corporation
Publisher: Pearson Education
Total Pages: 823
Release: 2012-01-15
Genre: Computers
ISBN: 0735669791

Maximize the impact and precision of your message! Now in its fourth edition, the Microsoft Manual of Style provides essential guidance to content creators, journalists, technical writers, editors, and everyone else who writes about computer technology. Direct from the Editorial Style Board at Microsoft—you get a comprehensive glossary of both general technology terms and those specific to Microsoft; clear, concise usage and style guidelines with helpful examples and alternatives; guidance on grammar, tone, and voice; and best practices for writing content for the web, optimizing for accessibility, and communicating to a worldwide audience. Fully updated and optimized for ease of use, the Microsoft Manual of Style is designed to help you communicate clearly, consistently, and accurately about technical topics—across a range of audiences and media.

Mark Writing

Mark Writing
Author: Angela Stockman
Publisher:
Total Pages: 108
Release: 2016-01-26
Genre: Education
ISBN: 9780986104930

In Make Writing, everyone's favorite education blogger and writing coach, Angela Stockman, turns teaching strategies and practice upside down. She spills you out of your chair, shreds your lined paper, and launches you and your writer's workshop into the maker space! Who even knew this was possible?

Toward a Composition Made Whole

Toward a Composition Made Whole
Author: Jody L. Shipka
Publisher: University of Pittsburgh Pre
Total Pages: 202
Release: 2011-04-30
Genre: Language Arts & Disciplines
ISBN: 0822977788

To many academics, composition still represents typewritten texts on 8.5" x 11" pages that follow rote argumentative guidelines. In Toward a Composition Made Whole, Jody Shipka views composition as an act of communication that can be expressed through any number of media and as a path to meaning-making. Her study offers an in-depth examination of multimodality via the processes, values, structures, and semiotic practices people employ every day to compose and communicate their thoughts. Shipka counters current associations that equate multimodality only with computer, digitized, or screen-mediated texts, which are often self-limiting. She stretches the boundaries of composition to include a hybridization of aural, visual, and written forms. Shipka analyzes the work of current scholars in multimodality and combines this with recent writing theory to create her own teaching framework. Among her methods, Shipka employs process-oriented reflection and a statement of goals and choices to prepare students to compose using various media in ways that spur their rhetorical and material awareness. They are encouraged to produce unusual text forms while also learning to understand the composition process as a whole. Shipka presents several case studies of students working in multimodal composition and explains the strategies, tools, and spaces they employ. She then offers methods to critically assess multimodal writing projects. Toward a Composition Made Whole challenges theorists and compositionists to further investigate communication practices and broaden the scope of writing to include all composing methods. While Shipka views writing as crucial to discourse, she challenges us to always consider the various purposes that writing serves.

Effective Documentation

Effective Documentation
Author: Stephen Doheny-Farina
Publisher: MIT Press
Total Pages: 376
Release: 1988
Genre: Computers
ISBN: 9780262040983

"Best Collection of Essays", NCTE Awards for Excellence in Technical and Scientific Communication. Effective Documentation is a major sourcebook that offers technical writers, editors, teachers, and students of technical communication a wide variety of practical guidelines based on often hard to find research in the usability of printed and electronic media. The book's eighteen chapters provide a wealth of material on such topics of current interest as the writing of design manuals, research in cognitive psychology as applied to the design of user manuals, and the organizing of manuals for hierarchical software systems. Included are chapters by such well known scholars in the field as Philip Rubens, Robert Krull, Judith Ramey, and John Carroll. Effective Documentation reviews the advice offered by other "how to produce usable documentation" books, describing the different types of usability research and explaining the inherent biases of each type. It goes beyond the actual design of textual and/or electronic media to look at these designs in context, giving advice on effective management ("good management is a requisite of good writing"), on the relationship between document design and product design, and on how to find out who one's readers really are. Advances in the presentation of textual information are explained, with suggestions on how to improve the usability of individual sentences and the design of entire books. The concluding chapters discuss advances in the design and use of online information and offer valuable insights into the use of graphic information and the development and design of information communicated via electronic media. Stephen Doheny Farina is Assistant Professor of Technical Communication at Clarkson University. Effective Documentationis included in the Information Systems series, edited by Michael Lesk.

Communicating Design

Communicating Design
Author: Dan M. Brown
Publisher: New Riders
Total Pages: 1040
Release: 2010-09-15
Genre: Computers
ISBN: 0131385410

Successful web design teams depend on clear communication between developers and their clients—and among members of the development team. Wireframes, site maps, flow charts, and other design diagrams establish a common language so designers and project teams can capture ideas, track progress, and keep their stakeholders informed. In this all new edition of Communicating Design, author and information architect Dan Brown defines and describes each deliverable, then offers practical advice for creating the documents and using them in the context of teamwork and presentations, independent of methodology. Whatever processes, tools, or approaches you use, this book will help you improve the creation and presentation of your wireframes, site maps, flow charts, and other deliverables. The book now features: An improved structure comprising two main sections: Design Diagrams and Design Deliverables. The first focuses on the nuts and bolts of design documentation and the second explains how to pull it all together. New deliverable: design briefs, as well as updated advice on wireframes, flow charts, and concept models. More illustrations, to help designers understand the subtle variations and approaches to creating design diagrams. Reader exercises, for those lonely nights when all you really want to do is practice creating wireframes, or for use in workshops and classes. Contributions from industry leaders: Tamara Adlin, Stephen Anderson, Dana Chisnell, Nathan Curtis, Chris Fahey, James Melzer, Steve Mulder, Donna Spencer, and Russ Unger. “As an educator, I have looked to Communicating Design both as a formal textbook and an informal guide for its design systems that ultimately make our ideas possible and the complex clear.” —Liz Danzico, from the Foreword