Writing Better Computer User Documentation


Book Description

Designed to help processing professionals and technical writers write clear, accurate computer user documentation. Presents a systematic approach to writing paper and online documentation. Version 2 retains much essential material from the first edition, while offering new information on desktop publishing, CASE tools and the ``software factory'' programming technologies. Also covers new techniques such as team writing, hypertext, mass storage and more.




Docs Like Code


Book Description

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.




Docs for Developers


Book Description

Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users’ needs to publishing, measuring, and maintaining useful developer documentation. Well-documented projects save time for both developers on the project and users of the software. Projects without adequate documentation suffer from poor developer productivity, project scalability, user adoption, and accessibility. In short: bad documentation kills projects. Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation—tools you can adapt to the needs of your own organization. What You'll Learn Create friction logs and perform user research to understand your users’ frustrations Research, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notes Publish and maintain documentation alongside regular code releases Measure the success of the content you create through analytics and user feedback Organize larger sets of documentation to help users find the right information at the right time Who This Book Is For Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.




Communicating the User Experience


Book Description

A clear and focused guide to creating useful user experience documentation As web sites and applications become richer and more complex, the user experience (UX) becomes critical to their success. This indispensible and full-color book provides practical guidance on this growing field and shares valuable UX advice that you can put into practice immediately on your own projects. The authors examine why UX is gaining so much interest from web designers, graduates, and career changers and looks at the new UX tools and ideas that can help you do your job better. In addition, you'll benefit from the unique insight the authors provide from their experiences of working with some of the world's best-known companies, learning how to take ideas from business requirements, user research, and documentation to create and develop your UX vision. Explains how to create documentation that clearly communicates the vision for the UX design and the blueprint for how it's going to be developed Provides practical guidance that you can put to work right away on their own projects Looks at the new UX tools and ideas that are born every day, aimed at helping you do your job better and more efficiently Covers a variety of topics including user journeys, task models, funnel diagrams, content audits, sitemaps, wireframes, interactive prototypes, and more Communicating the User Experience is an ideal resource for getting started with creating UX documentation.




High Growth Handbook


Book Description

High Growth Handbook is the playbook for growing your startup into a global brand. Global technology executive, serial entrepreneur, and angel investor Elad Gil has worked with high-growth tech companies including Airbnb, Twitter, Google, Stripe, and Square as they’ve grown from small companies into global enterprises. Across all of these breakout companies, Gil has identified a set of common patterns and created an accessible playbook for scaling high-growth startups, which he has now codified in High Growth Handbook. In this definitive guide, Gil covers key topics, including: · The role of the CEO · Managing a board · Recruiting and overseeing an executive team · Mergers and acquisitions · Initial public offerings · Late-stage funding. Informed by interviews with some of the biggest names in Silicon Valley, including Reid Hoffman (LinkedIn), Marc Andreessen (Andreessen Horowitz), and Aaron Levie (Box), High Growth Handbook presents crystal-clear guidance for navigating the most complex challenges that confront leaders and operators in high-growth startups.







LibreOffice 6.0 Writer Guide


Book Description

LibreOffice is a freely-available, full-featured office suite that runs on Windows, Linux, and macOS. This book is for beginners to advanced users of Writer, the word processing component. It covers setting up Writer to suit the way you work; using styles and templates; working with text, graphics, tables, and forms; formatting pages (page styles, columns, frames, sections, and tables); printing and mail merge; creating tables of contents, indexes, and bibliographies; using master documents and fields; creating PDFs; and more. This book was written by volunteers from the LibreOffice community. Profits from the sale of this book will be used to benefit the community. Free PDFs of this book and its individual chapters are available from http: //www.libreoffice.org/get-help/documentation




Developing Quality Technical Information


Book Description

Drawing on IBM's unsurpassed technical communications experience, readers discover today's best practices for meeting nine quality characteristics: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness. Packed with guidelines, checklists, and before-and-after examples, Developing Quality Technical Information, Third Edition is an indispensable resource for the future of technical communication.




The Nurnberg Funnel


Book Description

How do people acquire beginning competence at using new technology? The legendary Funnel of Nurnberg was said to make people wise very quickly when the right knowledge was poured in; it is an approach that designers continue to apply in trying to make instruction more efficient. This book describes a quite different instructional paradigm that uses what learners do spontaneously to find meaning in the activities of learning. It presents the "minimalist" approach to instructional design - its origins in the study of people's learning problems with computer systems, its foundations in the psychology of learning and problem solving, and its application in a variety of case studies. Carroll demonstrates that the minimalist approach outperforms the standard "systems approach" in every relevant way - the learner, not the system determines the model and the methods of instruction. It supports the rapid achievement of realistic projects right from the start of training, instead of relying on drill and practice techniques, and designing for error recognition and recovery as basic instructional events, instead of seeing error as failure. The book's many examples - including a brief discussion of recent commercial applications - will help researchers and practitioners apply and develop this new instructional technology. The Nurnberg Funnel inaugurates the Technical Communications series, edited by Ed Barrett. Author John M. Carroll has participated for a number of years as a leader in the interdisciplinary field of human-computer interactions. He has been: Manager of User Interface Theory and Design at IBM's Thomas J. Watson Research Center (1976-1994); a professor in Computer Science at Virginia Tech (through 2003); and is currently (2018) Distinguished Professor and co-Director of the College of Information Sciences and Technology's Laboratory for Computer Supported Collaboration and Learning at Pennsylvania State University. He is also the Director of the university's Center for Human-Computer Interaction. He has received numerous awards, especially for his contributions to Information Technology and its relationship with humans. ~Compiled from MIT Press and Penn State University: https://jcarroll.ist.psu.edu/ (Retrieved 2018, September 7.)