Docs for Developers: An Engineer’s Field Guide to Technical Writing
- ISBN-10
- 1484272161
- ISBN-13
- 9781484272169
- Category
- Computers
- Pages
- 225
- Language
- English
- Published
- 2021-10-01
- Publisher
- Apress
- Authors
- Jared Bhatti, Jen Lambourne, David Nunez
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.
Get the book
Similar books
-
Family History Digital Libraries
By William Sims BainbridgeOne named Sara and Timberlake had 11 male workers, 1 female worker, and 4 children workers, so it might have employed the Minor family.
-
Foundation Dreamweaver MX
By Craig Grannell, Jerome Turner, Matt StephensSo here's what we need to do to arrive at our layout: s Create the main table to hold all the page elements. s Deal with the navigation area which is ...
-
Cisco CCNA Certification, 2 Volume Set: Exam 200-301
By Todd LammleThis inclusive, two-book set provides what you need to know to succeed on the new CCNA exam. The set includes Understanding Cisco Networking Technologies: Volume 1 and the CCNA Certification Study Guide: Volume 2.
-
CompTIA Network+ Study Guide: Exam N10-006
By Todd Lammle... you can use: –a –A –c –n –r –R –S –s All nbtstat switches are case sensitive. Generally speaking, lowercase switches deal with NetBIOS names of hosts, ...
-
CompTIA Network+ Study Guide with Online Labs: N10-007 Exam
By Todd Lammle, Jon Buhagiar... you can use: –a –A –c –n –r –R –S –s All nbtstat switches are case sensitive. Generally speaking, lowercase switches deal with NetBIOS names of hosts, ...
-
CCNA: Cisco Certified Network Associate FastPass
By Todd LammleS The S reference point defines the point between the customer router and an ... with the letter E deal with using ISDN on the existing telephone network.
-
Stranger in the Chat Room
By Todd Hafer, Jedd HaferA sequel to In the Chat Room With God finds a group of teens contacted by a mysterious and increasingly malevolent character who claims to know about their encounters with the Almighty and challenges their beliefs. Original.
-
Error Correction Coding: Mathematical Methods and Algorithms
By Todd K. MoonM M−1∑ k=0 −∞ ∞ k=0 The average energy per signal E s ∫ can be related to the ... we will deal primarily with additive white Gaussian noise (AWGN), ...
-
Security+ Training Guide
By Todd King... to deal with most , but unfortunately not all , of these potential threats . ... The S / MIME standard implements encryption for message content using ...
-
CCDA: Cisco Certified Design Associate Study Guide: Exam 640-861
By Todd Lammle, Andy BarklS reference point The S reference point defines the reference point between ... with the letter E deal with using ISDN on the existing telephone network.