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:
This is a preview of subscription content, access via your institution.
Tom Johnson, “Code Samples,” I’d Rather Be Writing, accessed June 26, 2021, https://idratherbewriting.com/learnapidoc/docapis_codesamples_bestpractices.html.
“Creating Great Sample Code.” Google Technical Writing One, accessed on June 15, 2021, https://developers.google.com/tech-writing/two/sample-code.
Jarod Reyes, “How Twilio writes documentation,” Signal 2016, YouTube, accessed June 26, 2021, www.youtube.com/watch?v=hTMuAPaKMI4.
We’ve used example.com as the Corg.ly domain in line with RFC 676, which permits the use of example.com for documentation, https://tools.ietf.org/html/rfc6761.
Seyed Mehdi Nasehi, “What makes a good code sample? A study of programming Q&A in Stack Overflow,” 2013 IEEE International Conference on Software Maintenance, 2012.
Rights and permissions
© 2021 The Author(s), under exclusive license to APress Media, LLC, part of Springer Nature
About this chapter
Cite this chapter
Bhatti, J., Corleissen, Z.S., Lambourne, J., Nunez, D., Waterhouse, H. (2021). Integrating code samples. In: Docs for Developers. Apress, Berkeley, CA. https://doi.org/10.1007/978-1-4842-7217-6_5
Publisher Name: Apress, Berkeley, CA
Print ISBN: 978-1-4842-7216-9
Online ISBN: 978-1-4842-7217-6
eBook Packages: Professional and Applied ComputingProfessional and Applied Computing (R0)Apress Access Books