Docs for developers : an engineer's field guide to technical writing / Jared Bhatti, Zachary Sarah Corleissen, Jen Lambourne, David Nunez, Heidi Waterhouse
Bhatti, Jared, author.; Corleissen, Zachary Sarah, author.; Lambourne, Jen, author.; Nunez, David, author.; Waterhouse, Heidi, author.
2021
T11
Available Online

Linked e-resources

Linked Resource Online Access
Concurrent users Unlimited
Authorized users Authorized users
Document Delivery Supplied Can lend chapters, not whole ebooks

Details

Title Docs for developers : an engineer's field guide to technical writing / Jared Bhatti, Zachary Sarah Corleissen, Jen Lambourne, David Nunez, Heidi Waterhouse
Author Bhatti, Jared, author.
ISBN 9781484272176 (electronic bk.)
148427217X (electronic bk.)
1484272161
9781484272169
DOI https://doi.org/10.1007/978-1-4842-7217-6
Publication Details [Place of publication not identified] : Apress, 2021.
Language English
Description 1 online resource
Item Number 10.1007/978-1-4842-7217-6 doi
Call Number T11
Dewey Decimal Classification 808.06/6
Summary 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 documentationtools you can adapt to the needs of your own organization. You will: 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.
Access Note Access limited to authorized users.
Digital File Characteristics text file
PDF
Source of Description Online resource; title from PDF title page (SpringerLink, viewed October 14, 2021).
Added Author Corleissen, Zachary Sarah, author.
Lambourne, Jen, author.
Nunez, David, author.
Waterhouse, Heidi, author.
Available in Other Form Print version: 9781484272169
Linked Resources Online Access
Record Appears in Online Resources > Ebooks
All Resources
1. Getting Started
2. Researching Documentation
3. Designing Documentation
4. Drafting Documentation
5. Structuring Sets of Documentation
6. Integrating Code Samples and Visual Content
7. Measuring Documentation Success
8. Working With Contributors
9. Maintaining Documentation
10. Wrapping Up.

Browse Subjects

Show more subjects...

Statistics

from
to
Export