Handbook of Technical Writing


Book Description

New to this edition: Up-to-date information on on-line research and computer resources. A unique four-way access system enables users of the Handbook of Technical Writing to find what they need quickly and get on with the job of writing: 1. The hundreds of entries in the body of the Handbook are alphabetically arranged, so you can flip right to the topic at hand. Words and phrases in bold type provide cross-references to related entries. 2. The topical key groups alphabetical entries and page numbers under broader topic categories. This topical table of contents allows you to check broader subject areas for the specific topic you need. 3. The checklist of the writing process summarizes the opening essay on "Five Steps to Successful Writing" in checklist form with page references to related topics, making it easy to use the Handbook as a writing text. 4. The comprehensive index provides an exhaustive listing of related and commonly confused topics, so you can easily locate information even when you don't know the exact term you're looking for.




Business and Technical Writing


Book Description




The Insider's Guide to Technical Writing


Book Description

Every complex product needs to be explained to its users, and technical writers, also known as technical communicators, are the ones who do that job. A growing field, technical writing requires multiple skills, including an understanding of technology, writing ability, and great people skills. Whether you're thinking of becoming a technical writer, just starting out, or you've been working for a while and feel the need to take your skills to the next level, The Insider's Guide to Technical Writing can help you be a successful technical writer and build a satisfying career. Inside the Book Is This Job for Me? What does it take to be a technical writer? Building the Foundation: What skills and tools do you need to get started? The Best Laid Plans: How do you create a schedule that won’t make you go crazy? How do you manage different development processes, including Agile methodologies? On the Job: What does it take to walk into a job and be productive right away? The Tech Writer Toolkit: How do you create style guides, indexes, templates and layouts? How do you manage localization and translation and all the other non-writing parts of the job? I Love My Job: How do you handle the ups and downs of being a technical writer? Appendixes: References to websites, books, and other resources to keep you learning. Index




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.




HTTP/2 in Action


Book Description

Summary HTTP/2 in Action is a complete guide to HTTP/2, one of the core protocols of the web. Because HTTP/2 has been designed to be easy to transition to, including keeping it backwards compatible, adoption is rapid and expected to increase over the next few years. Concentrating on practical matters, this interesting book presents key HTTP/2 concepts such as frames, streams, and multiplexing and explores how they affect the performance and behavior of your websites. Purchase of the print book includes a free eBook in PDF, Kindle, and ePub formats from Manning Publications. About the Technology HTTP—Hypertext Transfer Protocol—is the standard for exchanging messages between websites and browsers. And after 20 years, it's gotten a much-needed upgrade. With support for streams, server push, header compression, and prioritization, HTTP/2 delivers vast improvements in speed, security, and efficiency. About the Book HTTP/2 in Action teaches you everything you need to know to use HTTP/2 effectively. You'll learn how to optimize web performance with new features like frames, multiplexing, and push. You'll also explore real-world examples on advanced topics like flow control and dependencies. With ready-to-implement tips and best practices, this practical guide is sure to get you—and your websites—up to speed! What's Inside HTTP/2 for web developers Upgrading and troubleshooting Real-world examples and case studies QUIC and HTTP/3 About the Reader Written for web developers and site administrators. About the Authors Barry Pollard is a professional developer with two decades of experience developing, supporting, and tuning software and infrastructure. Table of Contents PART 1 MOVING TO HTTP/2 Web technologies and HTTP The road to HTTP/2 Upgrading to HTTP/2 PART 2 USING HTTP/2 HTTP/2 protocol basics Implementing HTTP/2 push Optimizing for HTTP/2 PART 3 ADVANCED HTTP/2 Advanced HTTP/2 concepts HPACK header compression PART 4 THE FUTURE OF HTTP TCP, QUIC, and HTTP/3 Where HTTP goes from here




Document Drafting Handbook


Book Description




Engineers' Guide to Technical Writing


Book Description

Annotation An engineer with experience in the automotive and chemical process industries, Budinski has compiled material he used to train new engineers and technicians in an attempt to get his co-workers to document their work in a reasonable manner. He does not focus on the mechanics of the English language, but on the types of documents that an average technical person will encounter in business, government, or industry. He also thinks that students with no technical background should be able to benefit from the tutorial. c. Book News Inc




The MS-DOS Encyclopedia


Book Description

This newly updated and expanded volume contains detailed, thorough and accurate information on MS-DOS written for advanced-level programmers of all environments. Contains an index and appendixes.




A Strategic Guide to Technical Communication - Second Edition (US)


Book Description

A Strategic Guide to Technical Communication incorporates useful and specific strategies for writers, to enable them to create aesthetically appealing and usable technical documentation. These strategies have been developed and tested on a thousand students from a number of different disciplines over twelve years and three institutions. The second edition adds a chapter on business communication, reworks the discussion on technical style, and expands the information on visual communication and ethics into free-standing chapters. The text is accompanied by a passcode-protected website containing materials for instructors (PowerPoint lectures, lesson plans, sample student work, and helpful links).




Designing and Writing Online Documentation


Book Description

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