我们目前正在寻找方法来帮助系统管理员组的非编程成员熟悉用于日常系统管理员任务的 Python 脚本。
有没有人有任何建议的文档工具或最佳实践，我们可能会发现对这一目的有用？
编辑以解决 S.Lott 的评论:
首先，对于我最初的问题过于简短，我深表歉意。我的主要目标是确保有人，即使是非程序员，也能在我不在或离开组织的情况下轻松解决我的脚本问题。
我正在寻找的是技术组(例如系统管理员团队)中具有“脚本编码器”角色的其他人使用的实践。例如，在开始编写任务脚本之前，我养成了先在我们的共享 wiki 上写一篇文章详细解释每个步骤的习惯。然后，我将我的 Python 脚本基于这篇文章——将其用作伪代码。
我正在寻找的其他类型的例子:
使用 Sphinx 等工具提供易于获取的文档
在投入生产之前进行小组讨论以检查代码
允许小组成员首先手动检查流程(我们通常采用这种方式，但也许我们应该将其作为一种更常见的做法)
或者，即使不是更有值(value)，也同样有值(value)，例如:
发现大量注释是浪费时间，因为逻辑流程对非程序员来说仍然很陌生
倾向于使用 pexpect因为在使用高级模块时失去了冗长
以上只是我想到的一些例子。希望这能澄清问题!一如既往，感谢 SO'ers。
最佳答案
有一本关于这个主题的书 - “Python for Unix and Linux System Administration”。
还有一篇关于开发人员作品的文章，它可能会为您提供您可能想要关注的风格。
几乎任何人，无论他将如何应用它，都希望研究语言本身的基础知识。除了与标准 python 发行版一起分发的教程之外，网络上还有一个很好的入门。
关于python - 为非程序员记录 Python 脚本，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/3928021/