Abstract
This chapter guides you through how to turn the empathy you gained in Chapter 1 into action with a documentation plan, which outlines the content and content types you need to create before you start writing.
This is a preview of subscription content, access via your institution.
Buying options
Notes
- 1.
B.J. Keeton, “How to comment your code like a pro,” Elegant Themes, published April 3, 2019, www.elegantthemes.com/blog/wordpress/how-to-comment-your-code-like-a-pro-best-practices-and-good-habits.
- 2.
Omar Abdelhafith, “README.md: History and components,” Medium, published August 13, 2015, https://medium.com/@NSomar/readme-md-history-and-components-a365aff07f10.
- 3.
Shariq Nazr, “Say goodbye to manual documentation with these 6 tools,” Medium, published March 30, 2018, https://medium.com/@shariq.nazr/say-goodbye-to-manual-documentation-with-these-6-tools-9e3e2b8e62fa.
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). Planning your documentation. In: Docs for Developers. Apress, Berkeley, CA. https://doi.org/10.1007/978-1-4842-7217-6_2
Download citation
DOI: https://doi.org/10.1007/978-1-4842-7217-6_2
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