Sign-In
Cart
Technical Documentation Best Practices - Planning and Structuring Helpful User Assistance: Contents, Structure, User Navigation
Paperback
Series: Technical Documentation Best Practices
Technology & EngineeringGeneral ComputersProgramming
Publisher Price: $39.00
ISBN13: 9783943860122
Publisher: Lightning Source Inc
Published: Oct 25 2020
Pages: 174
Weight: 0.53
Height: 0.37 Width: 6.00 Depth: 9.00
Language: English
Even the best information is worthless if users can't find it. Providing user-friendly structure and navigation is just as important as providing well-written content. However, structuring user assistance isn't as simple and obvious as it may seem. If you think that your document structure should follow the structure of your product's components and functions: You're wrong. If you think that the type of document that you prefer is the same type of document that your clients prefer: You're wrong. If you think that all the information that you have is important: You're also wrong.
This book tells you how to structure, index, and link your documents so that readers actually find the information they need.
Topics covered:
- General structuring principles that all structural decisions have in common.
- Choosing media: Should you provide a printed or printable user manual (PDF), online help, or both? What information should go into the user manual, and what information should go into online help? Which help format should you use? Can context-sensitive help calls be implemented? Should you provide interactive features?
- Planning documents: Should you put all information into one document, or should you supply several user manuals for specific purposes and user groups? How should you name your documents?
- Planning document sections: What are the major sections that your documents should consist of? Are there any standard sections that you mustn't forget?
- Planning topics: What types of information do your clients need? How should you build and name the individual topics within the document?
- Planning the order of sections and topics: How should you organize the sections and topics within your documents? What comes first? What comes later?
- Planning navigation: Which navigational devices should you provide in printed documents and in online help systems? Where should you provide links or cross-references and where not?
3 different editions
Also available
Technical Documentation Best Practices - Writing Clear and Helpful User Assistance: Writing Rules, Tips, FAQ
Achtelig, Marc
Paperback
Also in
General Computers
All Data Are Local: Thinking Critically in a Data-Driven Society
Loukissas, Yanni Alexander
Paperback
Comptia Network+ Certmike: Prepare. Practice. Pass the Test! Get Certified!: Exam N10-008
Chapple, Mike
Zacker, Craig
Paperback
Interactive Theorem Proving and Program Development: Coq'art: The Calculus of Inductive Constructions
Castéran, Pierre
Bertot, Yves
Hardcover
Seven Databases in Seven Weeks: A Guide to Modern Databases and the Nosql Movement
Wilson, Jim
Perkins, Luc
Redmond, Eric
Paperback
R for Data Science: Import, Tidy, Transform, Visualize, and Model Data
Wickham, Hadley
Grolemund, Garrett
Paperback
The Reverse Centaur's Guide to Life After AI: How to Think about Artificial Intelligence--Before It's Too Late
Doctorow, Cory
Paperback
Designing Data-Intensive Applications: The Big Ideas Behind Reliable, Scalable, and Maintainable Systems
Kleppmann, Martin
Riccomini, Chris
Paperback
If Anyone Builds It, Everyone Dies: Why Superhuman AI Would Kill Us All
Yudkowsky, Eliezer
Soares, Nate
Hardcover
AI for Good: How Real People Are Using Artificial Intelligence to Fix Things That Matter
Tyrangiel, Josh
Hardcover
The Year in Tech, 2026: The Insights You Need from Harvard Business Review
Anthony, Scott D.
Webb, Amy
Review, Harvard Business
Paperback
Human Raised: Nurturing Connection, Curiosity & Lifelong Learning in the Age of AI
Suskind, Dana, MD
Hardcover
Hbr's 10 Must Reads on AI (with Bonus Article How to Win with Machine Learning by Ajay Agrawal, Joshua Gans, and AVI Goldfarb)
Davenport, Thomas H.
Iansiti, Marco
Review, Harvard Business
Paperback
A Giant Leap: How AI Is Transforming Healthcare and What That Means for Our Future
Wachter, Robert
Hardcover
The Agi Chronicles: The Inside Story of the Race to Create an Artificial Superintelligence
Roose, Kevin
Hardcover
The AI Con: How to Fight Big Tech's Hype and Create the Future We Want
Bender, Emily M.
Hanna, Alex
Hardcover
Generative Ai: The Insights You Need from Harvard Business Review
Mollick, Ethan
Cremer, David De
Review, Harvard Business
Paperback
CompTIA Network+ Certification All-in-One Exam Guide, Ninth Edition (Exam N10-009)
Weissman, Jonathan S.
Paperback
Fans First: Change The Game, Break the Rules & Create an Unforgettable Experience
Cole, Jesse
Paperback
AI Literacy in Any Class: Preparing Students to Thrive in an AI Future in Any Grade Level or Content Area
Miller, Matt
Paperback
Fundamentals of Data Engineering: Plan and Build Robust Data Systems
Housley, Matt
Reis, Joe
Paperback
Atlas of AI: Power, Politics, and the Planetary Costs of Artificial Intelligence
Crawford, Kate
Paperback
Minecraft: Guide Collection 4-Book Boxed Set (Updated): Survival (Updated), Creative (Updated), Redstone (Updated), Combat
Mojang Ab
The Official Minecraft Team
Hardcover
AI Snake Oil: What Artificial Intelligence Can Do, What It Can't, and How to Tell the Difference
Kapoor, Sayash
Narayanan, Arvind
Paperback
Python Crash Course, 3rd Edition: A Hands-On, Project-Based Introduction to Programming
Matthes, Eric
Paperback
We Are as Gods: A Survival Guide for the Age of Abundance
Diamandis, Peter H.
Kotler, Steven
Hardcover
AI with Intention: Principles and Action Steps for Teachers and School Leaders
Frontier, Tony
Paperback
Hands-On Machine Learning with Scikit-Learn and Pytorch: Concepts, Tools, and Techniques to Build Intelligent Systems
Géron, Aurélien
Paperback
Human + Machine, Updated and Expanded: Reimagining Work in the Age of AI
Wilson, H. James
Daugherty, Paul R.
Hardcover
The Eureka Machine: Why AI Is the Key to Unlocking a New Era of Scientific Discoveries
Socher, Richard
Hardcover
Artificial Intelligence: A Guide for Thinking Humans (with a New Preface)
Mitchell, Melanie
Paperback
The Thinking Machine: Jensen Huang, Nvidia, and the World's Most Coveted Microchip
Witt, Stephen
Hardcover
Hands-On Large Language Models: Language Understanding and Generation
Alammar, Jay
Grootendorst, Maarten
Paperback
The Black Swan: Second Edition: The Impact of the Highly Improbable: With a New Section: On Robustness and Fragility
Taleb, Nassim Nicholas
Paperback
Embedded Systems with ARM Cortex-M Microcontrollers in Assembly Language and C: Fourth Edition
Zhu, Yifeng
Paperback
Tubes: A Journey to the Center of the Internet with a New Introduction by the Author
Blum, Andrew
Paperback
The Empty Center: Permission, Connection, and What We Build When the Future is Uncertain
Drumwright, Hayes
Hardcover
CompTIA Tech+ Certification All-in-One Exam Guide, Third Edition (Exam FC0-U71)
Wempen, Faithe
Paperback
Fundamentals of Software Architecture: A Modern Engineering Approach
Ford, Neal
Richards, Mark
Paperback
Power and Prediction: The Disruptive Economics of Artificial Intelligence
Agrawal, Ajay
Gans, Joshua
Goldfarb, Avi
Hardcover
AI Projects with Raspberry Pi: High-Performance Artificial Intelligence for Robotics, Security, Home Automation, and Vision
Hattersley, Lucy
Jepson, Brian
Paperback
AP Computer Science a Premium, 13th Edition: Prep Book with 6 Practice Tests + Comprehensive Review + Online Practice (2026)
Teukolsky, Roselyn, M. S.
Carman, Chris
Paperback
Minecraft: Exploded Builds: Medieval Fortress: An Official Mojang Book
Mojang Ab
The Official Minecraft Team
Paperback
AP Computer Science Principles Premium, 2027: 6 Practice Tests + Comprehensive Review + Online Practice
Reichelson, Seth
Paperback
Love Machines: How Artificial Intelligence Is Transforming Our Relationships
Muldoon, James
Hardcover
AI Snake Oil: What Artificial Intelligence Can Do, What It Can't, and How to Tell the Difference
Narayanan, Arvind
Kapoor, Sayash
Hardcover
You Look Like a Thing and I Love You: How Artificial Intelligence Works and Why It's Making the World a Weirder Place
Shane, Janelle
Paperback
Minecraft: Roll for Adventure: The Temple of the Charged Creeper
Forbeck, Marty
Forbeck, Matt
Hardcover
The AI Ultimatum: Preparing for a World of Intelligent Machines and Radical Transformation
Hill, Paul
Brown, Steve
Paperback
You to the Power of Two: Redefining Human Potential in the Age of Identic AI
Bradley, Joseph
Tapscott, Don
Hardcover
The Devops Handbook, 2nd Edition: How to Create World-Class Agility, Reliability, & Security in Technology Organizations
Humble, Jez
Debois, Patrick
Kim, Gene
Paperback
Artificial Intelligence All-In-One for Dummies
Massaron, Luca
Minnick, Chris
Mueller, John Paul
Paperback
The Empty Center: Permission, Connection, and What We Build When the Future is Uncertain
Drumwright, Hayes
Paperback
The Death of Expertise: The Campaign Against Established Knowledge and Why It Matters
Nichols, Tom
Paperback
The Problem with Personalization: How Advertisers Learned to Make and Break Us from Ancient Times to the AI Age
Turow, Joseph
Hardcover
The Fourth Intelligence Revolution: The Future of Espionage and the Battle to Save America
Vinci, Anthony
Hardcover
Designing Machine Learning Systems: An Iterative Process for Production-Ready Applications
Huyen, Chip
Paperback
AI for Educators: Learning Strategies, Teacher Efficiencies, and a Vision for an Artificial Intelligence Future
Miller, Matt
Paperback
RHCSA Red Hat Enterprise Linux 10: Training and Exam Preparation Guide (EX200), Fourth Edition
Ghori, Asghar
Paperback
Graphic Artists Guild Handbook, 17th Edition: Pricing & Ethical Guidelines
The Graphic Artists Guild
Paperback
The Technological Republic: Hard Power, Soft Belief, and the Future of the West
Karp, Alexander C.
Zamiska, Nicholas W.
Hardcover
More Human: How the Power of AI Can Transform the Way You Lead
Carter, Jacqueline
Hougaard, Rasmus
Hardcover
Building Applications with AI Agents: Designing and Implementing Multiagent Systems
Albada, Michael
Paperback
Microsoft 365 Excel All-In-One for Dummies
Ringstrom, David H.
Alexander, Michael
Kusleika, Dick
Paperback
The Experimentation Machine: Finding Product-Market Fit in the Age of AI
Bussgang, Jeffrey J.
Hardcover
The Coming Wave: Technology, Power, and the Twenty-First Century's Greatest Dilemma
Suleyman, Mustafa
Hardcover
What Is Intelligence?: Lessons from AI about Evolution, Computing, and Minds
Aguera Y. Arcas, Blaise
Paperback
Hbr's 10 Must Reads on Artificial Intelligence, Updated and Expanded (Featuring How AI Can Help Managers Think Through Problems by Elisa Farri and Gab
Review, Harvard Business
Davenport, Thomas H.
Agrawal, Ajay
Paperback
Navigeren door het labyrint: Een handleiding voor het beheer van data
Sebastian-Coleman, Laura
Paperback
Prediction Machines, Updated and Expanded: The Simple Economics of Artificial Intelligence
Agrawal, Ajay
Gans, Joshua
Goldfarb, Avi
Hardcover
Comptia A+ Complete Study Guide, 2-Volume Set: Volume 1 Core 1 Exam 220-1201 and Volume 2 Core 2 Exam 220-1202
Buhagiar, Jon
Docter, Quentin
Paperback
Speak Data: Artists, Scientists, Thinkers, and Dreamers on How We Live Our Lives in Numbers
Lupi, Giorgia
Cox, Phillip
Paperback
A Whole New Human: Ten Ways We Must Evolve to Survive and Thrive in the AI Age
Rydall, Derek
Hardcover
On the Future of Species: Authoring Life by Means of Artificial Biological Intelligence
Woolfson, Adrian
Hardcover
R for Data Science: Import, Tidy, Transform, Visualize, and Model Data
Grolemund, Garrett
Cetinkaya-Rundel, Mine
Wickham, Hadley
Paperback
Laptops for Seniors in Easy Steps, 9th Edition: Covers All Laptops with the Windows 11 2024 Update
Vandome, Nick
Paperback