Author: Krista Van Laan
Publisher: XML Press
ISBN: 1457182424
Category : Reference
Languages : en
Pages : 512
Get Book Here
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
Author: Christopher Gales
Publisher:
ISBN:
Category : New products
Languages : en
Pages : 287
Get Book Here
Book Description
This book provides a broad perspective about the essential aspects of creating technical documentation in today's product development world. It is a book of opinions and guidance, collected as short essays. You can read selectively about subjects that interest you, or you can read the entire collection in any order you like. Information development is a multidimensional discipline, and it is easy to theorize. We have written this book from our direct experience, using the concrete insights and practices we apply to our work every day. If you work as an information developer, a manager in a documentation team, or in another part of product development that collaborates with a doc team, there is information in this book for you. Perhaps you are a technical writer in a small, high-growth company that is figuring out its processes. Perhaps you are an information-development manager in a large enterprise company with an expanding product line and an ever more complex matrix of cross-functional dependencies. You might work at a medium-sized company where your management is asking you to do more with fewer people, and you want some additional perspective that will help you find a leaner and more effective way to deliver what your business demands. Or you might work outside the technical documentation world, in another part of product development, and are wondering how to collaborate most effectively with the documentation team. The purpose of The Product is Docs is to provoke discussion, shine light on some murky areas, and--we hope--inspire our colleagues to consider their processes and assumptions with new eyes. -- Amazon.
Author: Kieran Morgan
Publisher: Technical Writing Process
ISBN: 9780994169310
Category : Communication of technical information
Languages : en
Pages : 0
Get Book Here
Book Description
"Plan, structure, write, review, publish"--Cover.
Author: David Kmiec
Publisher: John Wiley & Sons
ISBN: 1119070139
Category : Technology & Engineering
Languages : en
Pages : 198
Get Book Here
Book Description
Helps both engineers and students improve their writing skills by learning to analyze target audience, tone, and purpose in order to effectively write technical documents This book introduces students and practicing engineers to all the components of writing in the workplace. It teaches readers how considerations of audience and purpose govern the structure of their documents within particular work settings. The IEEE Guide to Writing in the Engineering and Technical Fields is broken up into two sections: “Writing in Engineering Organizations” and “What Can You Do With Writing?” The first section helps readers approach their writing in a logical and persuasive way as well as analyze their purpose for writing. The second section demonstrates how to distinguish rhetorical situations and the generic forms to inform, train, persuade, and collaborate. The emergence of the global workplace has brought with it an increasingly important role for effective technical communication. Engineers more often need to work in cross-functional teams with people in different disciplines, in different countries, and in different parts of the world. Engineers must know how to communicate in a rapidly evolving global environment, as both practitioners of global English and developers of technical documents. Effective communication is critical in these settings. The IEEE Guide to Writing in the Engineering and Technical Fields Addresses the increasing demand for technical writing courses geared toward engineers Allows readers to perfect their writing skills in order to present knowledge and ideas to clients, government, and general public Covers topics most important to the working engineer, and includes sample documents Includes a companion website that offers engineering documents based on real projects The IEEE Guide to Engineering Communication is a handbook developed specifically for engineers and engineering students. Using an argumentation framework, the handbook presents information about forms of engineering communication in a clear and accessible format. This book introduces both forms that are characteristic of the engineering workplace and principles of logic and rhetoric that underlie these forms. As a result, students and practicing engineers can improve their writing in any situation they encounter, because they can use these principles to analyze audience, purpose, tone, and form.
Author: Jared Bhatti
Publisher: Apress
ISBN: 9781484272169
Category : Computers
Languages : en
Pages : 0
Get Book Here
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.
Author: Michelle Carey
Publisher: Pearson Education
ISBN: 0133118975
Category : Computers
Languages : en
Pages : 612
Get Book Here
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.
Author: Krista Van Laan
Publisher: Alpha Books
ISBN: 9780028641461
Category : Reference
Languages : en
Pages : 333
Get Book Here
Book Description
Covers the field of technical writing, providing information on such topics as building a portfolio, writing an effective resume, finding well-paying jobs, passing a writing exam, and creating a document online.
Author: Miles A. Kimball
Publisher: Bedford/St. Martin's
ISBN: 9780312436995
Category : Language Arts & Disciplines
Languages : en
Pages : 440
Get Book Here
Book Description
The technological revolution of the last ten years has radically changed document designers' materials, processes, and tools of the trade. In short, choices about everything from typography and color to planning and production have changed -- even multiplied. The first new text for the college market in ten years, Kimball and Hawkins' Document Design assumes from the start that students are working online to produce a fuller range of print and online documents, designed and delivered differently in a digital world. Through practical, accessible advice and examples, Kimball and Hawkins lay out the array of elements and choices that document designers need to consider, all in the context of a rhetorical framework that allows students to see the effects of those choices. The only text to integrate a range of theoretical perspectives, visual perception, visual culture, and visual rhetoric, Document Design teaches students to think more critically about their own design decisions and to keep usability in mind every step of the way. True to its message, this artfully designed text practices the principles it teaches and is sure to become a reference that students will keep.
Author: Kenneth G. Budinski
Publisher: ASM International
ISBN: 1615031685
Category : Technology & Engineering
Languages : en
Pages : 397
Get Book Here
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
Author: Sarah Maddox
Publisher:
ISBN: 9781937434007
Category : Computers
Languages : en
Pages : 488
Get Book Here
Book Description
Takes you inside Confluence wiki for an in-depth guide to developing and publishing technical documentation on a wiki. While the book focuses on Confluence, the concepts and strategies apply to any wiki.
