Docs for Developers: An Engineer’s Field Guide to Technical Writing

© The Author(s), under exclusive license to APress Media, LLC, part of Springer Nature 2021

J. Bhatti et al.Docs for Developershttps://doi.org/10.1007/978-1-4842-7217-6_5

5. Integrating code samples

Jared Bhatti¹  , Zachary Sarah Corleissen², Jen Lambourne³, David Nunez⁴ and Heidi Waterhouse⁵

(1)

Berkeley, CA, USA

(2)

Victoria, BC, Canada

(3)

Cornwall, UK

(4)

San Francisco, CA, USA

(5)

Mounds View, MN, USA

 

Corg.ly: Showing how it works

Charlotte looked through her draft and the feedback from Karthik. Most edits had been straightforward: fixing a typo here and slightly restructuring the text there. Karthik’s other comments could be grouped into two questions:

• How can we explain this better?

• What does this look like in practice?

Charlotte knew from her team’s ...