Sign-In
Cart
Software User Documentation: A How To Guide for Project Staff
Paperback
Series: Software Engineering Project Management, Book 2
Technology & EngineeringApplicationsProgramming
ISBN13: 9781461133377
Publisher: Createspace Independent Publishing Platform
Published: Apr 25 2011
Pages: 154
Weight: 0.41
Height: 0.33 Width: 5.50 Depth: 8.50
Language: English
Every software project eventually arrives at the same uncomfortable moment: the product is built, the deadline is looming, and someone looks up from their keyboard and says, Oh - we'll need a manual. What follows is usually a disaster. A programmer's technical notes get processed through a word processor, repackaged with a title page, and handed to users who flip through it once, set it on a shelf, and never touch it again. The software fails not because it doesn't work, but because nobody can figure out how to use it.
Software User Documentation is the guide that prevents that outcome.
Written by Dr David Tuffley - senior lecturer in sociotechnical studies at Griffith University and a technical writer with decades of experience in both the Australian public service and the private sector - this compact, authoritative manual covers the entire documentation lifecycle from initial planning through to post-publication maintenance. It is grounded in IEEE Standard 1063, the internationally recognised benchmark for software user documentation, and it delivers that standard's wisdom in precisely the kind of clear, accessible prose it advocates.
The book opens with a bracing diagnosis: the computer industry has a documentation problem, and users are the ones who pay for it. The gap between a programmer's internal world and the everyday user's experience is not a technical problem - it is a communication problem. Bridging that gap requires a specific discipline, a specific method, and a specific set of skills. This book provides all three.
From the earliest chapters on preparation - how to gather source material, construct a documentation project plan, estimate time and resources, and profile your audience - to the nuanced craft of clear writing (active voice, present tense, short words over long ones, no tired clichés), the guide moves methodically through every stage of the process. Readers learn what makes first drafts work, how to structure a document so that users can find what they need without frustration, and how to handle error messages, appendixes, glossaries, and indexes in ways that serve rather than confuse.
There is practical wisdom here that textbooks rarely touch: how to survive writer's block, how to set up an ergonomic workspace, when to print a draft rather than edit on screen. The chapters on editing and proof-reading are meticulous without being pedantic, and the guidance on reviewing and field-testing manuals - who should do it, how to brief them, how to act on their feedback - reflects the hard-won experience of someone who has managed real documentation projects under real deadline pressure.
The final sections address online help systems, production and binding, version control, and the often-neglected art of document maintenance after publication. A comprehensive glossary of computer terms and a set of ready-to-use project forms round out the package.
What distinguishes this book from the narrow technical writing manuals that crowd the shelf is its insistence that good documentation is, at its heart, an act of translation - from the world of the machine into the world of the person sitting in front of it. Get that translation right, and users succeed. Get it wrong, and even brilliant software becomes shelfware.
If you write, commission, review, or manage software documentation - or if you simply want users to actually use what you build - this book belongs on your desk, not your shelf.
Also in
Technology & Engineering
All Data Are Local: Thinking Critically in a Data-Driven Society
Loukissas, Yanni Alexander
Paperback
The Age of Living Machines: How Biology Will Build the Next Technology Revolution
Hockfield, Susan
Paperback
Ingenious Patents: Bubble Wrap, Barbed Wire, Bionic Eyes, and Other Pioneering Inventions
Bennett, Jay
Ikenson, Ben
Hardcover
The Reverse Centaur's Guide to Life After AI: How to Think about Artificial Intelligence--Before It's Too Late
Doctorow, Cory
Paperback
Improvised Munitions Black Book: Complete and Unabridged in One Volume: Complete and Unabridged in One Volume
U S Government
Paperback
The Infinity Machine: Demis Hassabis, Deepmind, and the Quest for Superintelligence
Mallaby, Sebastian
Hardcover
AI for Good: How Real People Are Using Artificial Intelligence to Fix Things That Matter
Tyrangiel, Josh
Hardcover
The Story of Your Life: How Social Media Shapes the Way We Experience Everything
Jezer-Morton, Kathryn
Hardcover
Ultimate Guide: Wiring, Updated 10th Edition: Meets Current National Electrical Code Standards
The Editors of Creative Homeowner
Paperback
Like, Follow, Subscribe: Influencer Kids and the Cost of a Childhood Online
Latifi, Fortesa
Hardcover
Lightning Beneath the Sea: The Race to Wire the World and the Dawn of the Information Age
Tabor, James M.
Hardcover
Basic Butchering of Livestock & Game: Beef, Veal, Pork, Lamb, Poultry, Rabbit, Venison
Mettler, John J.
Paperback
No One's Coming: The Rogue Heroes Our Government Turns to When There's Nowhere Else to Turn
Hazzard, Kevin
Hardcover
The Agi Chronicles: The Inside Story of the Race to Create an Artificial Superintelligence
Roose, Kevin
Hardcover
Empire of Ink: The Printers, Rogues, and Radicals Who Invented the American Newspaper
Wright, Alex
Hardcover
The Problem with Plastic: How We Can Save Ourselves and Our Planet Before It's Too Late
Beyond Plastics
Enck, Judith
Mahoney, Adam
Hardcover
The Elements of Power: A Story of War, Technology, and the Dirtiest Supply Chain on Earth
Niarchos, Nicolas
Hardcover
Midnight in Chernobyl: The Untold Story of the World's Greatest Nuclear Disaster
Higginbotham, Adam
Paperback
The Home Blacksmith: Tools, Techniques, and 40 Practical Projects for the Home Blacksmith
Ridgway, Ryan
Paperback
Atlas of AI: Power, Politics, and the Planetary Costs of Artificial Intelligence
Crawford, Kate
Paperback
City on the Edge: Technology, Politics, and the Fight for the Soul of San Francisco
Weber, Jonathan
Hardcover
You Don't Need a Smartphone: A Practical Guide to Downgrading Your Phone and Upgrading Your Life
Lamm, August
Paperback
AI Snake Oil: What Artificial Intelligence Can Do, What It Can't, and How to Tell the Difference
Narayanan, Arvind
Kapoor, Sayash
Paperback
Generation Regeneration: Codesigning the Future of Cities Through Regenerative Placemaking
Cho, Tony
Hardcover
The Baofeng Radio Revolution: The Beginner Guerrilla's Guide to Break Through the Complexity, Secure Communications, and Prepare for Disaster With Pre
Code Publishing, Morse
Hardcover
The New Age of Sexism: How AI and Emerging Technologies Are Reinventing Misogyny
Bates, Laura
Hardcover
Meat: How the Next Agricultural Revolution Will Transform Humanity's Favorite Food--And Our Future
Friedrich, Bruce
Hardcover
Inconspicuous Consumption: The Environmental Impact You Don't Know You Have
Schlossberg, Tatiana
Paperback
Crisis Engineering: Time-Tested Tools for Turning Chaos Into Clarity
Dickerson, Mikey
Nitze, Marina
Weaver, Matthew
Paperback
The Trillion Dollar War Machine: How Runaway Military Spending Drives America Into Foreign Wars and Bankrupts Us at Home
Hartung, William D.
Freeman, Ben
Hardcover
Human + Machine, Updated and Expanded: Reimagining Work in the Age of AI
Daugherty, Paul R.
Wilson, H. James
Hardcover
Artificial Intelligence: A Guide for Thinking Humans (with a New Preface)
Mitchell, Melanie
Paperback
Curved Air: A Biography of Sickle Cell Anemia and the Quest to Cure the First Molecular Disease
Davies, Kevin
Hardcover
The Boy Who Harnessed the Wind: Creating Currents of Electricity and Hope
Kamkwamba, William
Mealer, Bryan
Paperback
Tubes: A Journey to the Center of the Internet with a New Introduction by the Author
Blum, Andrew
Paperback
Bringing Columbia Home: The Untold Story of a Lost Space Shuttle and Her Crew
Ward, Jonathan H.
Leinbach, Michael D.
Paperback
Broken Money: Why Our Financial System is Failing Us and How We Can Make it Better
Alden, Lyn
Paperback
CompTIA Tech+ Certification All-in-One Exam Guide, Third Edition (Exam FC0-U71)
Wempen, Faithe
Paperback
CNC Woodworking for the Absolute Beginner: Winning Tips, Techniques & 5 Skill-Building Projects
Bagnall, Ralph
Paperback
Pilot's Handbook of Aeronautical Knowledge: Faa-H-8083-25c
Federal Aviation Administration (FAA)
Hardcover
The Ultimate Guide to Rebuilding a Civilization: A Technical Manual for the Post-Collapse Era
Evans, James
Paperback
AI Projects with Raspberry Pi: High-Performance Artificial Intelligence for Robotics, Security, Home Automation, and Vision
Hattersley, Lucy
Jepson, Brian
Paperback
Disneyland and the Rise of Automation: How Technology Created the Happiest Place on Earth
Betancourt, Roland
Hardcover
Make: Electronics: Learning by Discovery: A Hands-On Primer for the New Electronics Enthusiast
Platt, Charles
Paperback
Cadillac Desert: The American West and Its Disappearing Water, Revised Edition
Reisner, Marc
Paperback
Agentic Artificial Intelligence: Harnessing AI Agents to Reinvent Business, Work, and Life
Bornet
Wirtz, Jochen
Davenport, Thomas H.
Paperback
The Powerful Primate: How Controlling Energy Enabled Us to Build Civilization
Ennos, Roland
Hardcover
AI Snake Oil: What Artificial Intelligence Can Do, What It Can't, and How to Tell the Difference
Narayanan, Arvind
Kapoor, Sayash
Hardcover
Drawing Lessons with Da Vinci: An Artist's Guide to Geometry, Anatomy and Proportion
Roig, Gabriel Martín
Paperback
The Fourth Intelligence Revolution: The Future of Espionage and the Battle to Save America
Vinci, Anthony
Hardcover
Texas DMV Driver's Handbook: Practice for the Texas Permit Test with 350+ Driving Questions and Answers
Prep, Discover
Paperback
The Mercury 13: The True Story of Thirteen Women and the Dream of Space Flight
Ackmann, Martha
Paperback
Agentic Artificial Intelligence: Harnessing AI Agents to Reinvent Business, Work, and Life
Davenport, Thomas H.
Bornet, Pascal
Wirtz, Jochen
Hardcover
The Unaccountability Machine: Why Big Systems Make Terrible Decisions--And How the World Lost Its Mind
Davies, Dan
Paperback
Bioinspired: How Nature Made Us Modern, Drives Today's Technological Innovation, and Inspires a Future Worth Inventing
Stier, Samuel Cord
Hardcover
Inconspicuous Consumption: The Environmental Impact You Don't Know You Have
Schlossberg, Tatiana
Hardcover
Feed the People!: Why Industrial Food Is Good and How to Make It Even Better
Rosenberg, Gabriel N.
Dutkiewicz, Jan
Hardcover
The Coming Wave: Technology, Power, and the Twenty-First Century's Greatest Dilemma
Suleyman, Mustafa
Hardcover
Kobuk the Destroyer: And Other Tales from the Wild, Unseen World of Test Engineering
Davies, Alex
Hardcover
Trapped Under the Sea: One Engineering Marvel, Five Men, and a Disaster Ten Miles Into the Darkness
Swidey, Neil
Paperback
The Ultimate Guide to Skinning and Tanning: A Complete Guide to Working with Pelts, Fur, and Leather
Burch, Monte
Paperback
Longitude: The True Story of a Lone Genius Who Solved the Greatest Scientific Problem of His Time
Sobel, Dava
Paperback
What Is Intelligence?: Lessons from AI about Evolution, Computing, and Minds
Aguera Y. Arcas, Blaise
Paperback
Engineering in Plain Sight: An Illustrated Field Guide to the Constructed Environment
Hillhouse, Grady
Hardcover