归档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以获得对脚本目的的描述以及其选项的摘要。

将解析器构建代码所使用的文档源与代码中的函数和类的实际文档字符串以及脚本本身链接起来可能相当简单。这取决于脚本的复杂性，但这通常是获取足够文档的低效方式。