Abstract
When my parents refurbished the wooden panels on the house in the 1980s, my mother deposited a newspaper in between the wall and the new panels. When I wondered what my mom was doing, she explained: “This is our message into the future. Whoever will be the next to replace the panels, will find the newspaper and see how we saw the world today.” Someone else, maybe a few decades later, would catch a glimpse of our life when the paneling was built (for instance that newspapers were considered to give testimony of history). Looking into the past is difficult. Of course, it is easier than looking into the future. There is some information: we can see the old, wooden panels, in their probably withered state. We can see what has been built, but not what our state of mind was, our hopes, our reasons, our intentions. Documenting software is similar.
Access this chapter
Tax calculation will be finalised at checkout
Purchases are for personal use only
Author information
Authors and Affiliations
Rights and permissions
Copyright information
© 2017 Kristian Rother
About this chapter
Cite this chapter
Rother, K. (2017). Documentation. In: Pro Python Best Practices. Apress, Berkeley, CA. https://doi.org/10.1007/978-1-4842-2241-6_17
Download citation
DOI: https://doi.org/10.1007/978-1-4842-2241-6_17
Published:
Publisher Name: Apress, Berkeley, CA
Print ISBN: 978-1-4842-2240-9
Online ISBN: 978-1-4842-2241-6
eBook Packages: Professional and Applied ComputingApress Access BooksProfessional and Applied Computing (R0)