O'Reilly logo

The Insider's Guide to Technical Writing by Krista Van Laan

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Location, Location, Location

Whether you produce mostly PDFs, mostly online help, or a combination of the two, someone must make a decision about where the content will reside. This means that it must be available to both internal and external customers, and it also must be stored for later use by the technical writing team. Many software products include help and PDF documentation in the software itself—in the “build” (the process of converting code into a standalone product). When the software is “built,” the content is included, as part of the software.

Including documentation within the build does guarantee that the help is always available, and not at the mercy of system maintenance or network problems. It can also be faster to access. Some ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required