Abstract
Success! Charlotte and Karthik watched the number of Corg.ly API users increase. Mei had emailed earlier in the week with congratulations and some initial feedback on the documentation and code. The celebrations were over, and, more than anything, Charlotte felt an immense sense of relief and accomplishment.
This is a preview of subscription content, access via your institution.
Buying options
Notes
- 1.
Riona Macnamara et al. “Do Docs Better: Integrating Documentation into the Engineering Workflow” in Seeking SRE, ed. David Blank-Edleman (O’Reilly Press, 2018).
- 2.
Torrey Podmajersky, Strategic writing for UX: Drive Engagement, Conversion, and Retention with Every Word, pp. 113–115 (O’Reilly, 2019).
- 3.
“The Limited English Proficient Population in the United States in 2013,” Jie Zong and Jeanne Batalova, Migration Policy Institute, published July 8, 2015, www.migrationpolicy.org/article/limited-english-proficient-population-united-states-2013.
- 4.
“How Many Software Developers Are in the US and the World?” DAXX, published February 9, 2020. Retrieved from: www.daxx.com/blog/development-trends/number-software-developers-world.
- 5.
Web Accessibility Initiative (WAI): Making the Web Accessible, accessed June 27, 2021, www.w3.org/WAI/.
- 6.
Brenda Jin, Saurabh Sahni, Amir Shevat, Designing Web APIs: Building APIs That Developers Love (O’Reilly Media, 2018).
- 7.
“Findability is a Content Problem, not a Search Problem” Mark Baker, Every Page is Page One, published May 2013, https://everypageispageone.com/2013/05/28/findability-is-a-content-problem-not-a-search-problem/.
- 8.
William Strunk, The Elements of Style. 4th ed. (Pearson, 1999).
- 9.
Hemingway Editor, www.hemingwayapp.com/.
- 10.
“Measuring your technical content – Part 1” Bob Watson, Docs by Design, published August 24, 2017, https://docsbydesign.com/2017/08/24/measuring-your-technical-content-part-1/.
Author information
Authors and Affiliations
Rights and permissions
Copyright information
© 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). Measuring documentation quality. In: Docs for Developers. Apress, Berkeley, CA. https://doi.org/10.1007/978-1-4842-7217-6_9
Download citation
DOI: https://doi.org/10.1007/978-1-4842-7217-6_9
Published:
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