A really "Software-Engineeringy" practice for making the company management system great again.
欢迎来到“软件工程”期末大作业的git存储库
这次我们的任务是开发一个公司管理系统,详见docs/requirement
中的介绍。
为了兼容性,所有文件使用LF
格式换行,且使用UTF-8
编码格式。在编辑器里可以轻松的确认这两项属性。
- 所有文件夹名称使用英文。
- 文档文件名可以使用中文。
- 代码文件名使用英文。
- 原则上,注释使用英文书写。
所有的文档在docs
中。文档包括:
- 开发计划(包括人员安排、进度计划)
- 需求分析文档
- 设计文档
- 测试计划
- 软件配置管理计划与最终配置库
- 测试报告
- 工作总结:小组成员每人写一份关于自己所做工作的汇报,最后由组长汇总写一份全组工作的总结报告
文档由中文撰写。每个人在docs/works
下将自己写的部分建立一个markdown文档。
比如韩嘉臻要写设计文档中员工时间管理部分,那么就在hanjz文件夹下创建
需求分析.md
,在里面写自己的部分。最后由组长(洪琦钧)归一,并放到docs
下。
所有的源码在src
中。代码的具体情况等文档写完后再讨论。
单元测试放在test
中。测试的具体情况等文档写完后再讨论。
预计该软件会使用LNMP
构建。
在windows下可以找我要虚拟机。
有关PHP的教程,可以看这里
p.s. 不需要您对php有多深的了解,会照葫芦画瓢就行。
如果您忘了MySQL的一些语法,可以看这里。
我们使用git存储库管理文件的协作相关工作。有关于git的相关教程请见这里。
您不需要对git有太多的了解,只需要知道它的基本概念和基本使用方法即可。
建议在windows下使用Git for Windows来完成git相关的工作。
我们选用的git托管服务是github。
在github上有将您的计算机通过SSH连接到github的教程(英文)。
我们用markdown撰写文档,有关markdown的基本语法的教程请见这里。
建议使用typora作为markdown编辑器。这是一个所见即所得的编辑器,使用起来相当方便。
关于其他文件的编辑,我推荐使用Visual Studio Code作为代码编辑器。它集成了一个简单的git客户端,使得您不用对git的命令行操作有太多了解就可以开始着手文件的编辑工作。