User: Password:
Subscribe / Log in / New account

Documentation as sanity checking

Documentation as sanity checking

Posted Jul 23, 2006 13:41 UTC (Sun) by fergal (guest, #602)
Parent article: Kernel Summit 2006: Documentation

I find documentation to be a great final step in the development of code. I have frequently made improvements to my code (especially to interfaces) as a result of trying to write documentation. If you can't document it easily then it's broken (the truth of this statement varies from domain to domain but I think it's a good first approximation).

Ideally that sort of stuff would be found in my design documentation but I (like many others) am merely mortal and get a bit too excited about bashing out code to write a detailed designed beforehand.

(Log in to post comments)

Copyright © 2017, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds