歸檔Python腳本非程序員

Question

目前，我們正在尋找各種方法來幫助系統管理員組的非編程成員熟悉與用於日常的一天系統管理員任務的Python腳本。

有沒有人有，我們可能會發現用於此目的的任何建議的文檔工具或最佳做法？

編輯，以解決美國洛特的評論：

首先，我的道歉是我最初的問題太簡單了。我的主要目標是確保一個人，甚至一個非程序員，很容易就能解決我的劇本，如果我不是在那一天，或者如果我離開組織。

我要找的是誰在一個技術小組的「腳本編碼器」作用的其他人，如系統管理員團隊使用的做法。例如，我開始腳本任務的過程之前，我已經得到了進入先寫在我們共同的wiki詳細解釋每一步的一篇文章的習慣。然後，我將我的Python腳本放在文章上 - 將其用作僞代碼。

的各種各樣的東西的其它例子我在尋找：

• 使用的工具，如斯芬克斯提供容易獲得DOC

• 有小組討論投入生產之前把代碼

• 允許小組成員先手動完成該過程（我們通常走這條路線，但也許我們應該讓它成爲更常見的做法）

或者，只是如果不是更多的話有價值，底片如：

• 研究發現，重評論是在浪費時間，因爲邏輯流程的仍然是外資非程序員

• 朝向使用pexpect因爲冗長的精益使用高層次模塊時

以上只是失去我想到的事情的例子。希望澄清這個問題！一如既往，感謝SO'ers。

Answer 1

有一本書對這個問題 - 「Python的Unix和Linux系統管理」。

• http://oreilly.com/catalog/9780596515829

而且對開發商的作品可能爲您提供您可能想跟着味道的文章。

• http://www.ibm.com/developerworks/aix/library/au-python/

以及幾乎任何一個，不管他是怎麼回事，要應用它的，希望對語言本身的基礎工作。除了與標準python發行版一起發佈的教程之外，還有一個很好的入門網站。

• http://diveintopython3.ep.io/

Answer 2

我發現，使用argparse作爲腳本調用解析/路由的基礎上往往會產生文檔體面的第一道防線。如果按預期方式使用，系統管理員可以運行some_script --help以獲得對腳本目的的描述以及其選項的摘要。

將解析器構建代碼所使用的文檔源與代碼中的函數和類的實際文檔字符串以及腳本本身鏈接起來可能相當簡單。這取決於腳本的複雜性，但這通常是獲取足夠文檔的低效方式。