前言

为什么会出现本指南?

故事要从团队中某位成员的一次的嵌入式小组项目说起。

这位成员是该小组的组长,他负责组织小组成员,分配任务,协调进度,以及最终的项目交付。 由于缺乏经验,他们在项目的软件开发之初,选择了不统一的开发环境,以及极其原始的版本管理方式。 出现了早上组员 A 使用 Keil 写代码和调试硬件,用 Word 来写开发文档。 下午的时候,组员 B 在自己配置的 CLion 环境中写代码,然后使用文本文档的方式来写开发文档。 组长每天的工作就是把两位组员的工作整合到一起,包括但不限于接收两位从 QQWeChat、邮件等渠道传来的代码,整合到一起,然后编译、调试、测试;接受两位组员复制过来的文字,再整理到自己准备的文档中。

两周过去了,组长发现自己每天的时间全部用在了整合工作上,而没有时间去做更有价值的事情。 在经过组长对现代开发工作流的了解和学习,小组讨论之后,决定抛弃“原始”的工作流,转而步入现代,使用统一的开发环境,以及专业的版本管理软件。 他们首先尝试了多种平台以及 IDE 自带的协作工具(例如 Jetbrains:Code with MeVisual Studio Code:Live Share),但是效果不尽人意。

后来经过一位高人指点,他们选择了使用 GitVisual Studio CodeMarkdownGitHub 等工具和平台来实现现代化的工作流,最终取得了良好的效果,而且该项目也最终获得省级奖项。

某一天,这位 Team Leader 回想起那段时光,决定将他们的经验分享给更多的人,希望能够帮助更多的人走出“原始”的工作流,进入现代的工作流,于是取名为 “步入现代”

本指南的目标

本指南的目标是帮助大家快速的入门“现代”的工作流以便能更好地协作。

本指南将会更多的介绍如何使用工具,而不是介绍工具的原理。

说到底,如何学习还是要看内驱力,如果能主动去查看文档,那么本指南可能对你来说并不是很有用。

参与建设

本项目仍在建设中,欢迎访问我们的 代码仓库 来参与建设。

在编写文档之前,请先阅读 贡献指南