Docs for Developers: An Engineer's Field Guide to Technical Writing by
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.
Engineering Writing by Design: Creating Formal Documents of Lasting Value (2e) by
Engineering Writing by Design: Creating Formal Document of Lasting Value, Second Edition shows how effective writing can be achieved by thinking like an engineer. Based on the authors' combined experience as engineering educators, the book presents a novel approach to technical writing, positioning formal writing tasks as engineering design problems with requirements, constraints, protocols, standards, and customers (readers) to satisfy. Specially crafted for busy engineers and engineering students, this quick-reading conversational text: Describes how to apply engineering design concepts to the writing process Explains how engineers fall into thinking traps, and gives techniques for avoiding them Covers the essentials of grammar, style, and mathematical exposition Highlights topics in writing ethics, including copyright, plagiarism, data presentation, and persuasion Engineering Writing by Design: Creating Formal Documents of Lasting Value, Second Edition addresses the specific combination of thinking and writing skills needed to succeed in modern engineering. Its mantra is: to write like an engineer, you must think like an engineer. Featuring illustrative examples, chapter summaries and exercises, quick-reference tables, and recommendations for further reading, this book is packed with valuable tips and information practicing and aspiring engineers need to become effective writers.
Writing for Engineers (4e) by
This book is full of practical advice and useful examples to help students and engineers write clearly, accurately and impressively. This updated fourth edition features new material on technical notes, inspection reports and business cases, along with abstracts and summaries. It is an essential aid for today's engineers.
Writer’s Reference Center provides users with a convenient one-stop location for all of the tools necessary to write and research effectively. From the mechanics of writing and grammar to style and research, this indispensable online resource thoroughly covers the fundamentals of quality writing, provides a wealth of vocabulary-building dictionaries, and presents a step-by-step guide to writing a good essay.