國立高雄大學圖資館 |

Language: English

Back

Docs for developersan engineer's fie...

Bhatti, Jared.

Docs for developersan engineer's field guide to technical writing /

Record Type:	Electronic resources : Monograph/item
Title/Author:	Docs for developersby Jared Bhatti ... [et al.].
Reminder of title:	an engineer's field guide to technical writing /
other author:	Bhatti, Jared.
Published:	Berkeley, CA :Apress :2021.
Description:	xxv, 225 p. :ill., digital ;24 cm.
Contained By:	Springer Nature eBook
Subject:	Technical writing
Online resource:	https://doi.org/10.1007/978-1-4842-7217-6
ISBN:	9781484272176$q(electronic bk.)

Docs for developersan engineer's field guide to technical writing /
Docs for developersan engineer's field guide to technical writing /[electronic resource] :by Jared Bhatti ... [et al.]. - Berkeley, CA :Apress :2021. - xxv, 225 p. :ill., digital ;24 cm.

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.

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. 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.

ISBN: 9781484272176$q(electronic bk.)

Standard No.: 10.1007/978-1-4842-7217-6doiSubjects--Topical Terms:

216078
Technical writing

LC Class. No.: T11

Dewey Class. No.: 808.066

Docs for developersan engineer's field guide to technical writing /
LDR:02721nmm a2200325 a 4500 001 609768
003 DE-He213
005 20210930154431.0
006 m d
007 cr nn 008maaau
008 220222s2021 cau s 0 eng d
020 $a 9781484272176$q(electronic bk.)
020 $a 9781484272169$q(paper)
024 7 $a 10.1007/978-1-4842-7217-6 $2 doi
035 $a 978-1-4842-7217-6
040 $a GP $c GP
041 0 $a eng
050 4 $a T11
072 7 $a UMW $2 bicssc
072 7 $a COM060160 $2 bisacsh
072 7 $a UMW $2 thema
082 0 4 $a 808.066 $2 23
090 $a T11 $b .D637 2021
245 0 0 $a Docs for developers $h [electronic resource] : $b an engineer's field guide to technical writing / $c by Jared Bhatti ... [et al.].
260 $a Berkeley, CA : $b Apress : $b Imprint: Apress, $c 2021.
300 $a xxv, 225 p. : $b ill., digital ; $c 24 cm.
505 0 $a 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.
520 $a 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. 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.
650 0 $a Technical writing $3 216078
650 1 4 $a Web Development. $3 760534
650 2 4 $a Open Source. $3 758930
700 1 $a Bhatti, Jared. $3 907548
710 2 $a SpringerLink (Online service) $3 273601
773 0 $t Springer Nature eBook
856 4 0 $u https://doi.org/10.1007/978-1-4842-7217-6
950 $a Professional and Applied Computing (SpringerNature-12059)