If you can write clear, concise instructions, then you can be a technical writer. Learn, step-by-step, how to turn your creative writing talent into a highly lucrative career, where you get paid big money consistently to use your writing skills.
This is the first collection of narratives by practicing technical communicators telling their own personal stories about the workplace and their lives on the job. The authors portray a wide range of jobs: writers, editors, interface designers, marketing writers, and trainers working in 9 different technical fields, including software, R&D, engineering, medicine, transportation, and telecommunications. The stories vividly demonstrate the unique power of narrative as a teaching and learning tool. Unlike fabricated cases, these real-life narratives show new and veteran technical writers at work on the job, dealing with tasks, clients, and co-workers, and revealing their insights, values, and attitudes about their work. The stories also show the skills required in the profession and the ethical and other issues raised in the course of the workday. For anyone interested in technical communication and professional writing.
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
"In this definitive guide to the ever-changing modern workplace, Kathryn Minshew and Alexandra Cavoulacos, the co-founders of popular career website TheMuse.com, show how to play the game by the New Rules. The Muse is known for sharp, relevant, and get-to-the-point advice on how to figure out exactly what your values and your skills are and how they best play out in the marketplace. Now Kathryn and Alex have gathered all of that advice and more in The New Rules of Work. Through quick exercises and structured tips, the authors will guide you as you sort through your countless options; communicate who you are and why you are valuable; and stand out from the crowd. The New Rules of Work shows how to choose a perfect career path, land the best job, and wake up feeling excited to go to work every day-- whether you are starting out in your career, looking to move ahead, navigating a mid-career shift, or anywhere in between"--
From the creator of the popular website Ask a Manager and New York’s work-advice columnist comes a witty, practical guide to 200 difficult professional conversations—featuring all-new advice! There’s a reason Alison Green has been called “the Dear Abby of the work world.” Ten years as a workplace-advice columnist have taught her that people avoid awkward conversations in the office because they simply don’t know what to say. Thankfully, Green does—and in this incredibly helpful book, she tackles the tough discussions you may need to have during your career. You’ll learn what to say when • coworkers push their work on you—then take credit for it • you accidentally trash-talk someone in an email then hit “reply all” • you’re being micromanaged—or not being managed at all • you catch a colleague in a lie • your boss seems unhappy with your work • your cubemate’s loud speakerphone is making you homicidal • you got drunk at the holiday party Praise for Ask a Manager “A must-read for anyone who works . . . [Alison Green’s] advice boils down to the idea that you should be professional (even when others are not) and that communicating in a straightforward manner with candor and kindness will get you far, no matter where you work.”—Booklist (starred review) “The author’s friendly, warm, no-nonsense writing is a pleasure to read, and her advice can be widely applied to relationships in all areas of readers’ lives. Ideal for anyone new to the job market or new to management, or anyone hoping to improve their work experience.”—Library Journal (starred review) “I am a huge fan of Alison Green’s Ask a Manager column. This book is even better. It teaches us how to deal with many of the most vexing big and little problems in our workplaces—and to do so with grace, confidence, and a sense of humor.”—Robert Sutton, Stanford professor and author of The No Asshole Rule and The Asshole Survival Guide “Ask a Manager is the ultimate playbook for navigating the traditional workforce in a diplomatic but firm way.”—Erin Lowry, author of Broke Millennial: Stop Scraping By and Get Your Financial Life Together
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.
Looking for a way to invigorate your technical writing team and grow that expertise to include developers, designers, and writers of all backgrounds? When you treat docs like code, you multiply everyone's efforts and streamline processes through collaboration, automation, and innovation. Second edition now available with updates and more information about version control for documents and continuous publishing.
In today's fast-paced work environment, where e-mail, fax machines, and FedEx have transformed the waypeople communicate, the ability to write succinctly and effectively onthe job can mean the difference between gaining or losing business. Based on the belief that real world simulations of workplace writingsituations provide the best opportunities for improvement, this bookinvites readers to consider actual relationships, situations, and theintangible elements that affect workplace writing. The tips and techniques offered in this book help readers developcritical thinking abilities in conjunction with occasions to practicerealistic workplace writing. Individual scenarios of various lengthsand levels of complexity provide abundant opportunities for readersto practice technical writing forms and learn about importantprinciples. Technical writers, business people, writersand workers training for such positions.
Taking a research-based, integrated problem solving approach to technical and professional writing, this volume provides a model that illustrates real working-world solutions to problems that readers are likely to encounter in the workplace. Designed to show that problem solving is a multidimensional process, each chapter begins with a short scenario case study that deals with theoretical or applied issues of technical and professional communication, thereby preparing users to excel in the professional world. The volume addresses a variety of forms of professionalism and problem solving including technical and rhetorical problem solving, solving problems through research, reports and completion reports, proposals, letters and memoranda's, solving problems through trip reports, feasibility studies, and lab reports, policy statements, manuals, and procedures, as well as solving problems in the professional job search, through document design, and through oral presentations. For business professionals and others who would benefit from enhanced problem-solving skills.