為自己的程式碼做的最重要一件事，就是告訴別人如何使用它，這有可能像只需要說明一點稍微複雜的邏輯那樣簡單，也有可能像編寫 3000 行長的程式介紹那麼複雜。我們把這些說明叫做文件。
文件既可能是說明如何使用程式的檔案，也可能會內嵌在程式碼中，它可以包含範例專案、教學或者每個函數的清單。編寫文件看上去像是一項佔用了編寫程式碼的時間的活動，然而，這卻是大多數程式設計師必須要做的工作。
占用編寫程式碼的時間難道不是一件糟糕的事嗎？事實上，文件為每個參與者所節省的時間之多，常常令人難以置信。如果很好地為程式碼編寫了文件，今後接手工作的所有程式設計師，都能更容易地搞明白程式碼是做什麼的，以及他們可以如何使用程式碼，他們就能擴充套件程式碼來做更多的事情，或者修改所出現的 Bug。
不僅如此，文件在將來可能還會對自己有所幫助。今天看上去很直觀的一些程式碼，明天可能就會令人很困惑。你可能真的忘記了為什麼總是需要給出一個引數，或者為什麼要用一個
try/except子句把函數包圍起來。
好的文件應該告訴使用者想要使用一段程式碼所需要知道的資訊，而且沒有廢話。試圖介紹每種可能的狀態或說明所編寫的每行程式碼，會很容易把程式碼淹沒在一個文件中。
過多的文件就像使用新數碼相機那 320 頁的使用者手冊一樣。你可能不會痛下決心去閱讀它。事實卻是如此，你可能只會在使用遇到困難時才會從文件中尋找解決方案，但是並不會太在意自己可能錯過了數百個其他功能。
好的文件應該是有組織的。其他的程式設計師會希望在特定的位置有某種特定型別的文件。關於函數能夠做什麼的說明，應該包含在函數中，並且通常要使用某種特定的格式。安裝說明不應該在程式碼中，而應該位於一個單獨的檔案中。對於需要些技巧的程式碼的詳細說明，應該在該程式碼的附近。
既然文件這麼有用，那麼應該如何編寫呢？怎樣才能編寫出“高大上”的 Python 軟體開發文件呢？請大家帶著問題繼續閱讀《如何編寫Python軟體開發文件（7個技巧）》一節。