Ste*_*ike 5 documentation project-management bug-tracking issue-tracking
这个问题的答案可能只是像jira或fogbugz这样的标准bug跟踪软件,但我有点希望那里有人知道我所描述的更好的系统.
我目前最新的项目需要大量的设置怪癖才能进入我可以实际开始编码部分的位置.例如:
这些东西中没有一个是巨大的,我已经写了很多关于我所做的确切命令和建议的笔记,但是它们目前在一般的文本文档中,并且很难记住确切的位置我需要的是远远不够的.我们也有很多新员工即将开始,我宁愿让他们更轻松地设置他们的编程环境.
就像我说的那样,它们并不是"编程怪癖",而只是在编程开始之前不断出现的问题.对于为自己和子孙后代的理智记录这些事情的最佳方法有何想法？
我们使用wiki来托管这样的指令.让每个人都知道访问信息的常见位置,并在步骤中的内容发生变化时使其保持最新,这样很容易.
如果有可以自动化的部件是个好主意,但如果需要非标准设置,我们总是为开发环境设置创建一个页面,以便有人必须重复.
将这些任务中的每一个封装到某种类型的脚本中(bash,python,applescript,autohotkey,适合任务的任何内容).
然后创建各种元脚本来调用它们.例如"set_up_everything.bash".
本质上:花时间编写一个脚本/程序,完成您需要做的所有事情,而不是花时间写下您需要做的所有事情.
如果脚本写得很干净,它们也会成为最终的文档形式(就像任何程序一样).
编辑:
重读你的问题,这也强烈地阐述了你关于协助新团队成员快速上手的观点:让他们运行脚本,然后bam!如果脚本不起作用(由于环境的差异等),它们仍然提供了一个很好的逐步完成需要进行的操作和命令.