Author: Christopher Gales
Publisher:
ISBN:
Category : New products
Languages : en
Pages : 287
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.
The Product is Docs
Author: Christopher Gales
Publisher:
ISBN:
Category : New products
Languages : en
Pages : 287
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.
Publisher:
ISBN:
Category : New products
Languages : en
Pages : 287
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.
Docs Like Code
Author: Anne Gentle
Publisher: Lulu.com
ISBN: 1387081322
Category : Computers
Languages : en
Pages : 118
Book Description
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.
Publisher: Lulu.com
ISBN: 1387081322
Category : Computers
Languages : en
Pages : 118
Book Description
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.
Docs for Developers
Author: Jared Bhatti
Publisher: Apress
ISBN: 9781484272169
Category : Computers
Languages : en
Pages : 0
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.
Publisher: Apress
ISBN: 9781484272169
Category : Computers
Languages : en
Pages : 0
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.
Developing Quality Technical Information
Author: Michelle Carey
Publisher: Pearson Education
ISBN: 0133118975
Category : Computers
Languages : en
Pages : 612
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.
Publisher: Pearson Education
ISBN: 0133118975
Category : Computers
Languages : en
Pages : 612
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.
Writing Software Documentation: A Task-Oriented Approach, 2/E
Author: Barker
Publisher: Pearson Education India
ISBN: 9788177587692
Category :
Languages : en
Pages : 500
Book Description
Publisher: Pearson Education India
ISBN: 9788177587692
Category :
Languages : en
Pages : 500
Book Description
The Insider's Guide to Technical Writing
Author: Krista Van Laan
Publisher: XML Press
ISBN: 1457182424
Category : Reference
Languages : en
Pages : 512
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
Publisher: XML Press
ISBN: 1457182424
Category : Reference
Languages : en
Pages : 512
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
Clear Technical Writing
Author: John A. Brogan
Publisher: Career Education
ISBN: 9780070079748
Category : Technical writing
Languages : en
Pages : 0
Book Description
Publisher: Career Education
ISBN: 9780070079748
Category : Technical writing
Languages : en
Pages : 0
Book Description
Essential Documents of American History, Volume I
Author: Bob Blaisdell
Publisher: Courier Dover Publications
ISBN: 0486797309
Category : History
Languages : en
Pages : 529
Book Description
The most important documents in American history: Declaration of Independence, Constitution, Emancipation Proclamation, presidential speeches, Supreme Court decisions, Acts and Declarations of Congress, essays, letters, and much more.
Publisher: Courier Dover Publications
ISBN: 0486797309
Category : History
Languages : en
Pages : 529
Book Description
The most important documents in American history: Declaration of Independence, Constitution, Emancipation Proclamation, presidential speeches, Supreme Court decisions, Acts and Declarations of Congress, essays, letters, and much more.
Hands-On UX Design for Developers
Author: Elvis Canziba
Publisher: Packt Publishing Ltd
ISBN: 1788624297
Category : Computers
Languages : en
Pages : 341
Book Description
This hands-on guide will teach you simple-to-advanced steps of user experience design. It starts from idea concept evaluation, product research, user interface design, and design implementation in code. We focus not only on the UI or design, but also on other things that are connected to it. UX has its own process that requires its own sets of ...
Publisher: Packt Publishing Ltd
ISBN: 1788624297
Category : Computers
Languages : en
Pages : 341
Book Description
This hands-on guide will teach you simple-to-advanced steps of user experience design. It starts from idea concept evaluation, product research, user interface design, and design implementation in code. We focus not only on the UI or design, but also on other things that are connected to it. UX has its own process that requires its own sets of ...
Product Roadmaps Relaunched
Author: C. Todd Lombardo
Publisher: "O'Reilly Media, Inc."
ISBN: 1491971673
Category :
Languages : en
Pages : 272
Book Description
A good product roadmap is one of the most important and influential documents an organization can develop, publish, and continuously update. In fact, this one document can steer an entire organization when it comes to delivering on company strategy. This practical guide teaches you how to create an effective product roadmap, and demonstrates how to use the roadmap to align stakeholders and prioritize ideas and requests. With it, you’ll learn to communicate how your products will make your customers and organization successful. Whether you're a product manager, product owner, business analyst, program manager, project manager, scrum master, lead developer, designer, development manager, entrepreneur, or business owner, this book will show you how to: Articulate an inspiring vision and goals for your product Prioritize ruthlessly and scientifically Protect against pursuing seemingly good ideas without evaluation and prioritization Ensure alignment with stakeholders Inspire loyalty and over-delivery from your team Get your sales team working with you instead of against you Bring a user and buyer-centric approach to planning and decision-making Anticipate opportunities and stay ahead of the game Publish a comprehensive roadmap without overcommitting
Publisher: "O'Reilly Media, Inc."
ISBN: 1491971673
Category :
Languages : en
Pages : 272
Book Description
A good product roadmap is one of the most important and influential documents an organization can develop, publish, and continuously update. In fact, this one document can steer an entire organization when it comes to delivering on company strategy. This practical guide teaches you how to create an effective product roadmap, and demonstrates how to use the roadmap to align stakeholders and prioritize ideas and requests. With it, you’ll learn to communicate how your products will make your customers and organization successful. Whether you're a product manager, product owner, business analyst, program manager, project manager, scrum master, lead developer, designer, development manager, entrepreneur, or business owner, this book will show you how to: Articulate an inspiring vision and goals for your product Prioritize ruthlessly and scientifically Protect against pursuing seemingly good ideas without evaluation and prioritization Ensure alignment with stakeholders Inspire loyalty and over-delivery from your team Get your sales team working with you instead of against you Bring a user and buyer-centric approach to planning and decision-making Anticipate opportunities and stay ahead of the game Publish a comprehensive roadmap without overcommitting