新手软件工程师须知

软件工程师
Author

jdragon

Published

September 28, 2024

本文所指新手软件工程师，指即将走上软件工程师岗位，还没有工作经验的应届毕业生（含本科和研究生）。

作为一个新手软件工程师，大的角度，应该做好两个方面的准备。

如果本科期间没有计算机科学与技术的基础，则还要抓紧弥补相关的知识短板。

笔者水平有限，如有疏漏之处，还请指出。

一、计算机科学技术基础

本部分旨在构建对计算机科学的基础认识，包括对计算机的基本理解、知识体系的构成以及编程与操作技能的掌握。此外，还强调了综合能力的重要性，如数学、英语以及阅读、沟通和团队协作技巧的提升，为学习者打下坚实的基础。

(一)基本认识和知识体系

此节从计算机的基本概念出发，逐步深入到计算机的知识体系结构，帮助读者建立起对计算机科学的全面认知框架。

1.对计算机的基本认识

在探讨如何成为一名优秀的软件工程师之前，首先必须对计算机有一个基本的认识。这不仅包括了解计算机的定义和历史发展，还需要理解其在现代社会中的作用。这种基础认识将帮助新手软件工程师建立对计算机本质的深刻理解，为后续的学习和发展奠定坚实的基础。

核心要点
  1. 定义：计算机是一种现代化的信息处理工具。信息是对数据所赋予的涵义，数据是对象的表示，无含义。处理可理解为变换。计算机对信息进行处理，并提供处理结果。计算机遵循一系列指令（程序）来执行各种任务。
  2. 历史发展：从早期的机械计算设备如算盘，到19世纪的差分机和分析机，再到20世纪的电子计算机，计算机的发展经历了巨大的变革。
  3. 作用：在现代社会中，计算机广泛应用于科学研究、教育、商业、医疗、娱乐等多个领域，极大地提高了工作效率和生活质量。
Checklist
参考资料介绍
总结

通过对计算机的基本认识的学习，我们不仅了解了计算机的定义和历史发展，还认识到其在现代社会中的重要作用。这些基础知识对于新手软件工程师来说至关重要，它们将帮助我们更好地理解计算机的本质，为未来的学习和实践打下坚实的基础。

2.计算机的知识体系

计算机的知识体系是构建现代信息技术世界的基石，它涵盖了从硬件到软件，从理论到实践的广泛领域。对于新手软件工程师而言，深入理解这一知识体系不仅有助于打下坚实的基础，还能在未来的职业生涯中持续提升个人的技术能力和创新能力。

核心要点
  • 计算机组成原理：了解计算机的基本结构和工作原理，包括中央处理器（CPU）、内存、输入输出设备等，以及它们如何协同工作。
  • 数据结构与算法：掌握常用的数据结构（如数组、链表、栈、队列、树、图）和基本算法（如排序、搜索），以及它们在解决实际问题中的应用。
  • 操作系统：理解操作系统的核心概念，包括进程管理、内存管理、文件系统、输入输出系统等，以及它们如何提供计算机资源的有效管理和调度。
  • 软件工程：学习软件开发的生命周期，包括需求分析、设计、编码、测试和维护，以及敏捷开发、版本控制等现代软件开发实践。
  • 编译原理：了解编译器的工作原理，包括词法分析、语法分析、语义分析、中间代码生成、代码优化和目标代码生成等阶段。
  • 数据库管理系统：学习数据库管理系统的概念和技能，包括关系型数据库、非关系型数据库、SQL语言的使用、数据库设计原则、性能优化和安全性等。
  • 计算机网络：掌握网络基础知识，如OSI模型、TCP/IP协议栈、路由和交换技术，以及网络安全和网络编程。
  • 信息安全：理解信息安全的基本原则和技术，包括加密、认证、访问控制、入侵检测和响应等。
  • 人工智能：探索AI的基础理论和应用，包括机器学习、深度学习、自然语言处理和计算机视觉等。
Checklist
参考资料介绍
  • CS自学指南
  • 《深入理解计算机系统》(Randal E. Bryant著)
  • 《计算机组成与设计：硬件/软件接口》（David A. Patterson 和 John L. Hennessy 著）
  • 《算法导论》（Thomas H. Cormen 等著）
  • 《现代操作系统》（Andrew S. Tanenbaum 和 Herbert Bos 著）
  • 《软件工程：实践者的研究方法》（Roger S. Pressman 著）
  • 《编译原理》（Alfred V. Aho, Monica S. Lam, Ravi Sethi, 和 Jeffrey D. Ullman 著）
  • 《数据库系统概念》（Abraham Silberschatz, Henry F. Korth, S. Sudarshanappa 著）
  • 《计算机网络：自顶向下方法》（James F. Kurose 和 Keith W. Ross 著）
  • 《计算机安全：原理与实践》（William Stallings 等著）
  • 《深度学习》（Ian Goodfellow, Yoshua Bengio, 和 Aaron Courville 著）
总结

计算机的知识体系是一个广泛而深入的领域，它要求新手软件工程师不仅要掌握理论知识，还要通过实践不断提升自己的技能。通过系统地学习和实践，新手软件工程师可以逐步建立起自己的知识框架，为未来的职业发展奠定坚实的基础。

(二)编程与操作技能

本节重点介绍编程技能与操作技能的培养，旨在通过实践提高解决实际问题的能力。

1.编程技能

编程技能是软件工程的核心，它不仅包括对编程语言的掌握，还涉及到算法设计、数据结构、软件开发生命周期的理解以及问题解决能力。一个优秀的软件工程师应能够熟练运用编程技能来解决实际问题，优化系统性能，并持续跟进技术的发展。

核心要点：
  1. 编程语言的选择：了解不同编程语言的特点和适用场景，如Python适合数据分析和快速原型开发，Java常用于企业级应用开发，C++适用于系统/应用软件开发等。
  2. 学习路径：建议从基础语言（如Python或Java）开始，逐步过渡到更复杂的语言（如C++或Go）。同时，重视数据结构和算法的学习，它们是编写高效代码的基础。
  3. 编程思维的培养：通过练习编程题和参与项目实践来培养逻辑思维、抽象能力和问题分解能力。
  4. 程序设计的基本功能：掌握函数、类、对象、继承、多态等面向对象编程的概念和应用。
  5. 算法效率：学习常见的算法和数据结构，如排序、搜索、栈、队列、链表、树、图等，并理解它们的时间复杂度和空间复杂度。
  6. 软件工程原则：熟悉SOLID原则、DRY原则等，这些原则有助于编写可维护和可扩展的代码。
  7. 版本控制与持续集成：掌握Git等版本控制工具的使用，了解持续集成/持续部署（CI/CD）的流程和工具。
  8. 测试驱动开发（TDD）：编写单元测试来验证代码的正确性，确保代码质量。
Checklist：
参考资料介绍：
  • 《C Primer Plus》（第6版）
  • 《Essential C++》
  • 《Python编程：从入门到实践》：适合初学者的Python教程。
  • 《Java核心技术 卷I》：深入讲解Java基础知识。
  • 《算法导论》：详细介绍算法设计和分析的经典教材。
总结：

编程技能是软件工程师不可或缺的基础能力，它要求我们不仅要熟练掌握一种或多种编程语言，还要具备扎实的算法基础、良好的编程习惯和持续学习的能力。通过不断实践和挑战自我，我们可以逐步成长为一名优秀的软件工程师。

2.操作技能

在成为一名合格的软件工程师的过程中，掌握操作系统使用、软件安装配置等基本操作技能是基础。这些技能不仅能够帮助新手快速适应工作环境，还能提高其工作效率和解决问题的能力。此外，了解如何高效利用计算机资源也是提升个人竞争力的关键因素之一。

核心要点
  1. 操作系统使用：熟悉至少一种主流操作系统（如Windows、Linux或macOS），包括文件系统管理、权限控制、进程监控等。
  2. 软件安装与配置：能够独立完成常用软件的下载、安装、更新及配置，理解软件依赖关系及其解决方法。
  3. 命令行工具：掌握基本的命令行操作，包括但不限于shell脚本编写、管道命令的使用、文本搜索过滤等。
  4. 版本控制工具：熟练使用Git进行版本控制，包括分支管理、合并冲突解决、代码回滚等操作。
  5. 容器化技术：了解Docker等容器化技术的基本概念和应用，能够在开发环境中使用容器部署和管理应用。
  6. 资源管理：学会监测和管理计算机资源，如CPU、内存使用情况，以及磁盘空间的有效分配。
  7. 自动化脚本：编写简单的自动化脚本来简化日常重复性工作，提高效率。
Checklist
参考资料介绍
  • 《鸟哥的Linux私房菜》：深入讲解Linux操作系统的使用和管理。
  • 《UNIX环境高级编程》：详细介绍了Unix环境下的编程接口和习惯用法。
  • Pro Git书籍：全面覆盖Git版本控制系统的使用。
  • Docker官方文档：学习Docker及相关容器化技术的权威指南。
  • Top/htop, df/du等命令的手册页：学习如何监控系统资源使用情况。
总结

对于新手软件工程师而言，操作技能是其职业生涯的起点。通过系统地学习和实践上述核心要点，不仅可以快速融入团队，还能为后续的技术深造打下坚实的基础。务必重视这些看似基础却极其重要的技能，它们是通向成功的重要阶梯。

(三)综合能力提升

强调除了专业技能外，数学逻辑、英语能力以及良好的阅读、沟通和团队协作技巧对于计算机科学领域同样重要。

1.数学与英语

数学和英语在计算机科学中扮演着至关重要的角色。数学提供了处理复杂问题和逻辑推理的基础，而英语则是全球计算机科学领域的主要交流语言。掌握这两门学科对于成为一名优秀的软件工程师至关重要。

核心要点
数学

  1. 离散数学：图论、集合论、逻辑和证明等是计算机科学的基础。例如，使用Dijkstra算法解决最短路径问题时，需要理解图论的基本概念。

    \[ \text{Dijkstra}(G, \text{start}) = \{ \text{distance}[v] = \infty \ | \ v \in V \} \]

  2. 线性代数：矩阵运算在图像处理、机器学习等领域广泛应用。例如，主成分分析（PCA）降维技术基于特征值分解。

    \[ \text{PCA}(X) = U \Sigma V^T \]

  3. 概率论与统计：用于数据分析、机器学习模型评估等。例如，贝叶斯定理在垃圾邮件过滤中的应用。

    \[ P(A|B) = \frac{P(B|A)P(A)}{P(B)} \]

  4. 微积分：优化算法如梯度下降法依赖于多变量微积分。

    \[ abla f(\theta) = \frac{\partial}{\partial \theta_i} f(\theta) \]

英语

  1. 技术文档阅读：大多数开源项目和技术规范都是用英语编写的。能够阅读和理解这些文档对于学习和实践至关重要。

  2. 国际交流：加入全球开发者社区需要良好的英语沟通能力。

  3. 编程语言：虽然许多编程语言支持多种自然语言，但英语仍是主流编程语言（如Python、Java）的主要语言。

Checklist
参考资料介绍

为了深入学习数学和英语在计算机科学中的应用，可以参考以下资料：

  • 《离散数学及其应用》（Kenneth H. Rosen）
  • 《线性代数及其应用》（David C. Lay）
  • 《概率论与数理统计》
总结

数学和英语是计算机科学不可或缺的两部分。数学提供了解决问题的工具和方法，而英语则是获取知识和国际交流的桥梁。对于新手软件工程师而言，掌握这两门学科将大大提升其职业竞争力和发展潜力。通过不断学习和实践，可以逐步提高在这两个方面的能力，为未来的职业生涯打下坚实的基础。

2.阅读、沟通及团队协作技巧

在软件开发领域，技术能力虽然至关重要，但有效的沟通、协作以及持续的知识扩展同样不可或缺。软件工程师不仅需要编写高效代码，还必须能够清晰地表达想法、理解他人观点，并在团队中有效合作。此外，通过广泛阅读，软件工程师可以不断更新知识库，保持与行业发展同步。

核心要点
  1. 沟通技巧：包括口头和书面沟通能力，能够清晰、准确地传达信息，并有效地倾听他人意见。
  2. 团队协作：理解团队合作的重要性，学习如何在团队环境中发挥作用，包括角色认知、责任分配和冲突解决。
  3. 阅读习惯：培养定期阅读的习惯，关注行业新闻、技术博客、书籍和研究论文，以获取新知识。
  4. 知识管理：学会整理和回顾所学知识，使用工具如笔记应用或知识库来系统地管理信息。
Checklist
参考资料介绍
  • 《人月神话》：探讨软件工程项目中的团队协作和管理问题。
  • 《代码大全》：提供编码最佳实践和团队开发的指导原则。
  • 《软技能：代码之外的生存指南》：涵盖职业发展、生产力提升和个人品牌建设等方面。
总结

对于新手软件工程师而言，掌握阅读、沟通及团队协作的技巧是职业成长的关键。这些技能有助于提高工作效率，促进个人与团队之间的和谐合作，同时也是适应快速变化的技术环境的必要条件。通过不断学习和实践，软件工程师可以在职业生涯中取得更大的成功。

二、新手上道

本部分针对新手软件工程师，提供了一系列从入门到实践的指导，包括工程概念的理解、职业素养的培养、软件开发的实践以及编程语言与工具的熟练运用。

(一)工程概念与职业素养

介绍工程、产品、项目的基本概念，以及作为计算机科学专业人员应具备的职业素养和团队合作能力。

1.建立工程、产品、项目的概念

在软件开发的广阔领域中，清晰地理解“工程”、“产品”与“项目”这三个核心概念及其相互间的关系，对于新手软件工程师而言至关重要。新手软件工程师必须要特别明确，自己是在从事工程、产品和项目相关的工作，这和过去学生时代的小规模程序设计是完全不同的。

核心要点
  • 工程（Engineering）： 工程是指应用科学原理和技术手段来设计、建造和维护结构物或系统的活动。在软件领域，工程强调的是系统性和可持续性，涉及从需求分析、设计、编码到维护的整个生命周期管理。它是实现软件产品功能、性能、安全性等非功能特性的关键途径。
  • 产品（Product）： 产品是满足市场需求或用户期望的有形或无形物品。软件产品特指那些经过精心设计、开发并投入市场以满足特定用户需求的软件实体，如应用程序、系统平台或服务。它关注的是用户体验、市场适应性及商业价值，是连接技术与市场的桥梁。
  • 项目（Project）： 项目是为了创造独特的产品、服务或成果而进行的临时性努力。软件开发项目则是围绕特定目标，在一定时间内，利用限定资源完成的一次性任务。它侧重于目标达成的效率和效果，通常具有明确的开始和结束时间，是实践工程方法和产品理念的具体载体。
Checklist
参考资料介绍
  • 《软件开发的科学与艺术》by 陈宏刚、林斌等
  • 《工程思维》by Mark N. Horenstein
  • 《软件工程最佳实践》by Capers Jones
  • 《营销管理》by Philip Kotler and Kevin Lane Keller：阅读其中和需求、产品相关的部分。
总结

综上所述，“工程”、“产品”与“项目”三者虽各有侧重，但在软件开发实践中紧密相连，相辅相成。新手软件工程师需深刻理解它们的内涵与外延，学会在不同的情境下灵活切换视角，以全面、系统的方式推进软件的开发与迭代。通过不断实践与反思，逐步建立起一套适合自己的方法论体系，为成为一名卓越的软件工程师奠定坚实的基础。

2.基本职业素养的养成

在软件开发领域，职业素养不仅关乎个人职业生涯的发展，还直接影响到团队协作、项目质量和企业声誉。对于新手软件工程师而言，培养良好的职业素养是其成长过程中不可或缺的一部分。本章节将探讨软件工程师应具备的基本职业道德、责任感以及终身学习的重要性。

核心要点
  • 职业道德：软件工程师应当遵守诚实守信的原则，保护用户隐私和数据安全，尊重他人的知识产权，避免任何形式的抄袭或不当竞争行为。
  • 责任感：对自己的代码负责，确保其正确性、可读性和可维护性。同时，对项目的成功负有责任，积极参与团队合作，及时沟通问题并提出解决方案。
  • 终身学习：技术领域日新月异，软件工程师需要不断更新知识和技能，适应新技术的变化。通过阅读专业书籍、参加在线课程和技术交流会等方式，保持学习的主动性和持续性。
  • 沟通能力：有效的沟通能够减少误解和冲突，提高团队效率。软件工程师应学会清晰地表达自己的想法，同时也要善于倾听他人的意见。
  • 批判性思维：面对问题时，能够独立思考，分析问题的多个方面，提出合理的解决方案。
  • 适应性和灵活性：在快速变化的市场环境中，能够迅速适应新工具、新流程和新需求。
  • 时间管理：合理安排工作和学习时间，确保按时完成任务并有足够的时间进行自我提升。
  • 团队合作：理解团队目标，与团队成员建立良好的合作关系，共同解决问题。
  • 专业态度：在工作中展现出专业性，包括着装、言谈举止以及对工作的认真态度。
  • 创新精神：鼓励创新思维，不断寻找改进现有产品和方法的机会。
Checklist
参考资料介绍
  • 《代码整洁之道：程序员的职业素养》by Robert C. Martin
  • 《匠艺整洁之道：程序员的职业修养》by Robert C. Martin
  • 《软技能：代码之外的生存指南》（Soft Skills: The Software Developer’s Life Manual） by John Sonmez
总结

基本职业素养的培养是一个持续的过程，它要求软件工程师不断地自我反省、学习和成长。通过遵循上述核心要点，并利用checklist来监督自己的进步，新手软件工程师可以逐步构建起坚实的职业基础，为未来的职业生涯打下坚实的基石。记住，优秀的职业素养不仅是个人成功的保证，也是推动整个行业向前发展的关键因素。

3.团队合作与文档编写

在软件工程师的职业生涯中，团队合作和文档编写是两个不可忽视的重要方面。高效的团队合作能够显著提升项目的完成速度和质量，而清晰、准确的文档则是项目成功的关键保障。良好的文档不仅能够帮助团队成员理解项目需求和设计思路，还能为未来的维护和扩展提供有力支持。

核心要点
  1. 团队合作的重要性：
    • 沟通与协调：有效的沟通是团队合作的基础。通过定期会议、即时通讯工具以及面对面的交流，确保信息传达的准确性和及时性。
    • 角色分工：明确团队中每个成员的角色和职责，避免重复劳动和责任不清的情况。
    • 信任与尊重：建立团队成员之间的信任和尊重，鼓励开放的讨论和反馈，促进创新和问题解决。
  2. 主要文档类别：
    • 需求文档：详细记录项目需求，包括功能需求和非功能需求。使用用户故事（User Stories）和用例图（Use Case Diagrams）等方法来描述需求。
    • 设计文档：包括系统架构图、类图、序列图等，帮助理解系统的设计和实现细节。
    • 测试文档：包含测试计划、测试用例和测试报告，确保软件质量。
    • 用户手册和技术文档：为用户提供详细的操作指南，为开发者提供技术参考，确保软件的使用和维护。
  3. 版本控制与文档管理：

    • 版本控制系统：使用Git等版本控制系统来管理文档的版本，确保文档的历史记录和协作开发。

      git init
git add .
git commit -m "Initial commit"
git push origin main

    • 文档管理系统：采用Confluence、Markdown等工具来组织和管理文档，提高文档的可访问性和可维护性。

Checklist
参考资料
  • 《软件工程：实践者的研究方法》（Roger S. Pressman 著）
总结

团队合作和文档编写是软件工程师不可或缺的技能。通过有效的沟通和明确的角色分工，可以提升团队的协作效率。清晰、准确的文档不仅有助于项目的顺利进行，还能为未来的维护和扩展提供重要支持。掌握这些技巧和方法，将使新手软件工程师在职业生涯中更加游刃有余。

4.口头表达技巧

在软件工程师的职业生涯中，有效的口头表达和演讲技巧是不可或缺的。这些技能不仅有助于清晰传达技术概念、项目进展和创新想法，还能增强个人影响力和说服力，促进团队合作与决策过程。掌握口头表达技巧对于提升个人职业形象、建立信任关系以及推动职业发展具有重要意义。

核心要点
  • 清晰的结构：使用“问题—解决方案—益处”的结构来组织演讲内容，确保听众能够迅速抓住重点。
  • 逻辑性：确保论述的逻辑连贯，避免跳跃式思维，使听众能够顺畅地跟随你的思路。
  • 简洁明了：避免冗长和复杂的表述，用简单直接的语言传达信息。
  • 非语言沟通：注意肢体语言、面部表情和眼神交流，以增强说服力。
  • 适应听众：根据听众的背景和兴趣调整演讲内容和风格。
  • 练习与反馈：通过模拟演讲和收集反馈来不断改进口头表达技巧。
checklist
参考资料介绍
  • 暂缺
总结

口头表达技巧是软件工程师软技能的重要组成部分，它能够帮助工程师更有效地沟通思想、影响他人并推动项目向前发展。通过不断练习和学习，每位软件工程师都可以提高自己的口头表达能力，从而在职场上取得更大的成功。

(二)软件工程与开发实践

深入探讨敏捷开发、SOLID原则、设计模式等软件开发的核心概念，以及如何实施软件质量保证措施和版本控制。

1.敏捷开发

敏捷开发是一种以人为本、迭代和增量的软件开发方法。它强调在开发过程中能够快速响应变化，持续交付有价值的软件，并在整个项目生命周期中保持高质量的代码和设计。本章节旨在为新手软件工程师介绍敏捷开发的基本原则和实践，以便更好地理解和应用于项目中。

敏捷开发的核心在于适应性和灵活性，它允许团队在面对需求变更时能够迅速调整计划，而不是僵化地遵循预先设定的计划。这种方法特别适合于需求不明确或可能发生变化的项目。通过短周期的迭代，敏捷开发确保了项目能够及时获得反馈，从而不断改进产品功能和用户体验。

核心要点
  1. 个体与交互：重视团队成员之间的直接沟通，认为面对面的交流比过程和工具更重要。
  2. 可工作的软件：优先于详尽的文档，强调定期交付可运行的软件版本。
  3. 客户合作：与客户紧密合作，确保软件满足客户需求。
  4. 响应变化：欢迎需求的变化，即使是在开发的后期阶段。
  5. 持续迭代：通过短周期的迭代来逐步完善软件。
  6. 团队自我组织：鼓励团队自主管理其工作方式。
Checklist
参考资料介绍
  • 《敏捷软件开发：原则、模式与实践》：介绍敏捷开发的方法学。
总结

敏捷开发不仅仅是一种软件开发方法，它是一种文化和思维方式，要求团队成员具备高度的自我管理能力和对变化的敏感性。通过实施敏捷原则和实践，新手软件工程师可以更快地适应项目需求的变化，提高开发效率，最终交付高质量的软件产品。

2.编码规范

编码规范在软件开发过程中扮演着至关重要的角色，它确保了代码的质量和一致性。通过遵循一定的规则和约定，编码规范有助于提高代码的可读性、可维护性和协作效率。良好的编码规范可以减少错误，促进团队间的有效沟通，并使项目更加易于管理。

核心要点
命名约定
  • 变量名应具有描述性，能够清晰地表达其用途和含义。
  • 使用驼峰式命名法（camelCase）或下划线命名法（snake_case）来区分不同的作用域。
  • 避免使用保留字和关键字作为变量名。
格式
  • 保持代码缩进一致，通常使用4个空格进行缩进。
  • 每行代码的长度不超过80个字符，以便于阅读和理解。
  • 使用合适的空行使代码块之间有清晰的分隔。
注释
  • 为复杂的代码逻辑添加注释，解释其工作原理和目的。
  • 使用多行注释来解释较长的代码段，而不是单行注释。
  • 避免过度注释，只对关键部分进行注释。
checklist
参考资料介绍
  • PEP 8 - Python编程风格指南
  • Google Java编程风格指南
  • Microsoft C# 编码规范
总结

编码规范是软件开发中不可或缺的一部分，它有助于提高代码质量、可读性和可维护性。通过遵循命名约定、格式和注释等核心要点，我们可以确保代码的一致性和易读性。同时，定期检查checklist可以帮助我们保持编码规范的遵守情况。最后，参考其他编程语言的编码规范也是一个不错的选择，可以借鉴其中的好的做法和经验。

3.整洁代码

整洁代码是软件工程中一种重要的编程实践，旨在提高代码的可读性、可维护性和可扩展性。它不仅确保了代码的功能正确性，还关注代码的结构和表达方式，从而降低长期维护成本，提高开发速度，并促进团队合作。通过遵循一系列原则和技术，开发者可以创建出既高效又易于维护的软件系统。

核心要点

  1. DRY（Don’t Repeat Yourself）原则：避免重复代码。如果一个功能在多个地方都需要实现，那么应该将其抽象出来，形成通用的函数或者模块。这样可以减少代码量，提高代码的可维护性。

  2. 命名规范：变量、函数、类的命名应该具有描述性，能够清晰地表达其功能和意图。避免使用模糊不清的名称，如tmp、var等。

  3. 注释和文档：适当的注释可以帮助他人理解代码的功能和逻辑，但过多的注释也会导致代码冗余。因此，应该在关键的地方添加注释，而不是对每一行代码都进行解释。同时，编写详细的文档也是非常重要的。

  4. 代码格式：保持代码格式的一致性，如缩进、空格、换行等。这有助于提高代码的可读性。

Checklist
参考资料介绍
  • 《代码整洁之道》by Robert C. Martin
  • 《代码大全》第二版 by Steve McConnell
  • 《重构: 改善既有代码的设计》by Martin Fowler
  • 重构：网址，涵盖了代码的坏味道和重构方法。
总结

整洁代码是一种重要的编程实践，它强调编写清晰、简洁且易于理解的代码。通过遵循一系列原则和技术，如单一职责原则、DRY原则等，开发者可以创建出既高效又易于维护的软件系统。这不仅有助于降低长期维护成本，提高开发速度，还能促进团队合作。因此，作为新手软件工程师，掌握整洁代码的实践是非常重要的。

4.SOLID编码原则

解析SOLID原则，指导新手编写高质量、可维护的代码。

核心要点

SOLID原则是面向对象编程和设计中的一系列指导原则，旨在提高软件的可维护性和可扩展性。SOLID是以下五个原则的首字母缩写：

  • 单一职责原则（Single Responsibility Principle, SRP） : 每个类应该只有一个引起变化的原因，即一个类应该只负责一项职责。这有助于减少类之间的耦合，使得每个类的变化不会影响到其他类。例如，一个UserService类应该只处理与用户相关的逻辑，而不涉及其他业务逻辑。
  • 开闭原则（Open/Closed Principle, OCP） : 软件实体（类、模块、函数等）应该对扩展开放，对修改封闭。这意味着在添加新功能时，应尽量通过继承或组合现有类来实现，而不是修改现有类的代码。这样可以避免引入错误和增加维护难度。
  • 里氏替换原则（Liskov Substitution Principle, LSP） : 子类型必须能够替换掉它们的父类型，这是面向对象设计的基本原则之一。这意味着在任何使用父类的地方，都可以用其子类来代替而不会影响程序的正确性。
  • 接口隔离原则（Interface Segregation Principle, ISP） : 不应该强迫客户依赖于它们不用的接口，即接口应该尽量细化，使其更加具体和专用。这有助于减少系统的复杂性和提高灵活性。
  • 依赖倒置原则（Dependency Inversion Principle, DIP） : 高层模块不应该依赖于低层模块，两者都应该依赖于抽象。抽象不应该依赖于细节，细节应该依赖于抽象。这有助于降低模块间的耦合度，提高系统的灵活性和可维护性。
Checklist
参考资料介绍
  • 《重构：改善既有代码的设计》是一本关于如何通过重构来改善代码质量的书籍，其中也涉及到了SOLID原则的应用。
总结

SOLID原则是一种重要的面向对象设计和编程的理念，它可以帮助开发者创建出更加灵活、可维护的软件系统。通过遵循这些原则，我们可以有效地减少代码间的耦合，提高系统的可扩展性和复用性。

5.设计模式

设计模式是解决特定问题的成熟解决方案，它们是经过验证的最佳实践。常见的设计模式包括创建型模式、结构型模式和行为型模式。

设计模式在软件工程中扮演着至关重要的角色。它们是解决特定问题的最佳实践，是经过验证的解决方案，可以帮助开发者避免从头开始设计，从而节省时间和资源。设计模式提供了一种通用的语言，使得开发者可以更容易地交流和理解彼此的代码。此外，设计模式还可以提高代码的可复用性、可维护性和灵活性，使软件系统更加健壮和易于扩展。

核心要点
  • 创建型模式（Creational Patterns : 创建型模式用于处理对象创建过程中的问题，使对象的创建和使用分离。常见的创建型模式包括单例模式、工厂方法模式、抽象工厂模式、建造者模式、原型模式。
  • 结构型模式（Structural Patterns : 结构型模式用于处理类或对象的组合问题，通过简化设计来增强系统的结构。常见的结构型模式包括适配器模式、桥接模式、组合模式、装饰器模式、外观模式、享元模式、代理模式。这些模式帮助设计灵活且可维护的系统结构。
  • 行为型模式（Behavioral Patterns : 行为型模式用于处理类或对象之间的交互问题，通过定义对象之间的通信方式来增强系统的灵活性和可扩展性。常见的行为型模式包括策略模式、模板方法模式、观察者模式、迭代器模式、责任链模式、命令模式、解释器模式、状态模式、备忘录模式、访问者模式、中介者模式、代理模式。这些模式帮助设计灵活且可维护的系统行为。
Checklist

在应用设计模式时，需要注意以下几点：

  1. 理解问题：首先，需要深入理解要解决的问题，以便选择合适的设计模式。
  2. 不要过度使用：设计模式是一种工具，而不是目标。不应该为了使用设计模式而使用设计模式。
  3. 保持简单：尽可能选择最简单的解决方案。复杂的设计模式可能会引入不必要的复杂性。
  4. 考虑性能：虽然设计模式可以提高代码的可复用性和可维护性，但也可能影响性能。因此，在选择设计模式时，需要考虑其对性能的影响。
  5. 持续学习：设计模式是一个不断发展的领域，新的模式不断出现。因此，需要持续学习和更新知识。
参考资料介绍
  • 《设计模式：可复用面向对象软件的基础》是一本详细介绍设计模式的经典书籍，其中包括了23种经典设计模式的详细解释和应用实例。
  • 设计模式：网址，包括了设计模式的各种语言的实现代码。
总结

设计模式是软件工程中的重要工具，它们提供了一种通用的语言，帮助开发者解决常见的软件设计问题。通过理解和应用这些模式，开发者可以提高代码的可复用性、可维护性和灵活性，使软件系统更加健壮和易于扩展。然而，需要注意的是，设计模式只是一种工具，而不是目标。在使用设计模式时，需要深入理解问题，选择合适的模式，并考虑其对性能的影响。

6.软件质量

软件质量是衡量一个软件产品在满足用户需求、提供稳定服务以及维护成本控制等方面表现的标准。高质量的软件不仅能够提高用户满意度，还能显著降低后期的维护和升级成本。对于新手软件工程师而言，理解并掌握如何评估和提升软件质量至关重要。

核心要点
  1. 功能性（Functionality）：确保软件实现所有预期功能，并符合用户需求。
  2. 可靠性（Reliability）：软件应能持续稳定运行，不出现故障或错误。
  3. 可用性（Usability）：软件应易于理解和使用，用户界面友好。
  4. 效率（Efficiency）：软件应有效利用资源，如内存、处理器时间等。
  5. 可维护性（Maintainability）：软件应易于修改、更新和扩展。
  6. 可移植性（Portability）：软件应能在不同的硬件或操作系统平台上运行。
Checklist
参考资料介绍
  • 《代码大全》第二版 by Steve McConnell
  • 《代码质量》 by Diomides Spinellis
总结

软件质量是软件开发过程中不可或缺的一部分，它直接影响到产品的成功与否。作为新手软件工程师，必须了解并掌握如何评估和提升软件质量的方法。通过关注功能性、可靠性、可用性、效率、可维护性和可移植性这六个核心要点，并运用相应的检查清单来确保每个方面都得到妥善处理，可以显著提高软件的整体质量。此外，不断参考最新的研究资料和行业最佳实践也是提升个人技能的重要途径。

7.软件质量保障措施

在软件开发过程中，确保高质量的代码和功能是至关重要的。这不仅有助于减少后期维护成本，还能提升用户体验和满意度。软件质量保障措施包括软件测试、代码审查等，旨在通过系统化的方法识别和修复潜在的缺陷，从而提高软件的可靠性和稳定性。

核心要点
1. 软件测试

软件测试是验证和确认软件是否满足其设计要求的过程。测试可以分为不同层次，包括单元测试、集成测试、系统测试和验收测试。每个层次的测试都有其特定的目标和方法。

  • 单元测试：针对软件的最小可测试单元（如函数或方法）进行测试。通常使用测试框架（如JUnit、pytest）来编写和执行测试用例。

  • 集成测试：验证各个模块之间的接口是否正确交互。这通常在单元测试之后进行，以确保模块集成后的功能正确性。

  • 系统测试：对整个系统进行全面测试，以验证其符合所有规定的需求。这包括功能测试、性能测试、安全性测试等。

  • 验收测试：也称为用户验收测试（UAT），由最终用户进行，以验证软件是否符合业务需求和用户期望。

2. 代码审查

代码审查是一种通过人工检查代码来发现潜在错误和改进代码质量的方法。常见的代码审查方法包括：

  • 同行审查：由同事或团队成员对代码进行检查，可以发现错误、改进代码风格和结构。

  • 正式审查：采用结构化的方法，如Fagan检查，通过预先定义的步骤和角色进行代码审查。

3. 持续集成与持续部署

持续集成（CI）和持续部署（CD）是现代软件开发中的重要实践。通过自动化构建、测试和部署流程，可以快速发现和修复问题，提高开发效率。

  • 持续集成：开发人员频繁地将代码集成到主分支，每次集成都自动运行一系列测试，确保新代码不会破坏现有功能。

  • 持续部署：在持续集成的基础上，自动化将通过测试的代码部署到生产环境，缩短发布周期，提高软件交付速度。

Checklist

为了确保软件质量保障措施的有效实施，可以使用以下checklist：

参考资料
  • 《代码大全》第二版 by Steve McConnell
总结

软件质量保障措施是确保软件高质量和高可靠性的关键步骤。通过系统的软件测试、严格的代码审查以及持续集成与持续部署的实践，可以有效地识别和修复潜在问题，提升软件的整体质量。对于新手软件工程师而言，掌握这些方法和最佳实践，将有助于他们在职业生涯中不断提升自己的技能和专业素养。

8.版本控制与持续集成实践

在软件开发过程中，版本控制系统（Version Control System, VCS）和持续集成/持续部署（Continuous Integration/Continuous Deployment, CI/CD）是确保代码质量、提高开发效率和维护团队协作的关键工具。版本控制系统允许开发者跟踪和管理代码变更，而CI/CD流程则自动化了代码的构建、测试和部署过程。这些实践不仅有助于减少人为错误，还能加快软件交付速度，提升产品质量。

核心要点

  1. 版本控制: 使用如Git这样的分布式版本控制系统来管理项目的历史记录和变更。掌握基本命令如commit, push, pull, branch, merge等，以及如何利用分支策略（如Git Flow）来组织开发流程。

  2. 持续集成 (CI): 通过自动化构建和测试代码来尽早发现集成错误。常用的CI工具包括Jenkins, Travis CI, CircleCI等。配置CI服务器监听代码仓库的变更，并在每次提交后自动运行构建和测试脚本。

  3. 持续部署 (CD): 扩展自CI，自动化将应用部署到生产环境的过程。这要求更高级的自动化测试和发布管理策略，以确保只有通过所有测试的代码才能被部署。

  4. 基础设施即代码 (IaC): 使用代码来管理基础设施的配置，如使用Terraform或Ansible。这使得基础设施的变更可以像应用代码一样进行版本控制和自动化部署。

  5. 监控与反馈: 设置监控工具来跟踪应用的性能和健康状况，确保快速响应任何问题。同时，收集用户反馈以持续改进产品。

Checklist
参考资料介绍
  • “Pro Git” by Scott Chacon and Ben Straub - 深入了解Git的高级用法和工作流程。
  • Jenkins官方文档 - 学习如何设置和使用Jenkins进行持续集成。
总结

版本控制和CI/CD实践对于现代软件开发至关重要。它们不仅提高了开发效率，还增强了产品的可靠性和安全性。通过采纳这些实践，新手工程师可以更快地融入团队，同时也为职业生涯打下坚实的基础。随着技术的发展，持续学习和适应新的工具和方法将是每个软件工程师不变的课题。

9.测试驱动开发（TDD）与行为驱动开发（BDD）介绍

测试驱动开发（Test-Driven Development, TDD）和行为驱动开发（Behavior-Driven Development, BDD）是现代软件开发中两种重要的方法，旨在提高软件的质量和可维护性。这两种方法都强调在编写实际代码之前先编写测试用例，从而确保代码的正确性和稳定性。它们在敏捷开发环境中尤为流行，有助于快速响应变化和持续交付高质量的软件产品。

核心要点
测试驱动开发（TDD）
  1. 循环过程：TDD遵循红-绿-重构的循环过程。首先编写失败的单元测试（红色），然后编写足够的代码让测试通过（绿色），最后对代码进行重构以提高其质量。
  2. 单元测试：TDD主要关注于单元测试，即针对软件中的最小可测试部分编写测试。
  3. 设计改进：通过先写测试的方式，开发者可以更好地思考接口设计和程序结构，从而设计出更加清晰和模块化的代码。
  4. 工具支持：JUnit、NUnit、PHPUnit等单元测试框架为TDD提供了强有力的支持。
行为驱动开发（BDD）
  1. 业务导向：BDD更侧重于从业务角度出发，使用非技术语言描述软件的行为。
  2. 共享词汇表：BDD鼓励开发团队与业务分析师共同创建“共享词汇表”，以确保所有人对需求有相同的理解。
  3. 验收标准：BDD强调可执行的规格说明，即“活着”的文档，这些文档可以直接转化为自动化测试。
  4. 工具支持：Cucumber、SpecFlow等工具支持BDD的实践，允许以自然语言编写测试用例。
Checklist
参考资料介绍
  • 《测试驱动开发：实践与模式解析》by Kent Beck
总结

TDD和BDD都是推动高质量软件开发的有效方法。它们通过提前考虑测试来引导开发过程，帮助团队构建出更加健壮、可靠且易于维护的软件系统。虽然两者在某些方面有所不同，但它们都强调了测试的重要性，并将其作为设计和开发过程中的一个核心部分。对于新手软件工程师而言，掌握这些技能不仅可以提高个人的编码能力，还能更好地融入团队并与之协作，共同提升软件项目的整体质量。

(三)编程语言与工具熟练度

指导新手如何选择和学习主流编程语言，熟悉常用的开发工具和框架，并探索与AI合作开发的策略。

1.主流编程语言学习路径

在软件开发领域，掌握一门或多门主流编程语言是进入该行业的基础。不同的编程语言适用于不同的应用场景，因此，理解各语言的特点及其适用环境对于新手软件工程师至关重要。此外，了解如何高效地学习这些编程语言也是提高开发效率和项目成功率的关键。

核心要点
C/C++
  • 特点：C语言是许多现代编程语言的基础，具有高效性和灵活性；C++在C的基础上增加了面向对象的特性。广泛应用于系统编程、游戏开发、嵌入式系统等领域。
  • 资源：《C程序设计语言》，《C++ Primer》，以及在线平台如GeeksforGeeks, TutorialsPoint。
  • 学习路径：基础语法 → 数据类型与操作 → 控制结构 → 函数 → 文件操作 → 指针和内存管理（C）→ 面向对象编程（C++）。
Python
  • 特点：易于学习，广泛应用于数据分析、人工智能、网络开发等领域。
  • 资源：《Python编程：从入门到实践》，《Python核心编程》等书籍；在线课程如Codecademy, Coursera。
  • 学习路径：基础语法 → 数据结构与算法 → Web框架（Django/Flask）→ 数据分析（Pandas, NumPy）→ 机器学习库（Scikit-learn）。
JavaScript
  • 特点：Web前端开发必备，也可用于后端开发（Node.js）。
  • 资源：《JavaScript高级程序设计》，《你不知道的JavaScript》，MDN Web Docs。
  • 学习路径：基础语法 → DOM操作 → 前端框架（React, Angular, Vue）→ Node.js。
Java
  • 特点：强类型语言，广泛用于企业级应用、Android开发。
  • 资源：《Java核心技术卷I》，《Effective Java》。
  • 学习路径：基础语法 → 面向对象编程 → Java标准库 → Spring框架。
C
  • 特点：微软开发的语言，主要用于.NET平台。
  • 资源：《C# in Depth》，《Pro C#》。
  • 学习路径：基础语法 → .NET基础 → ASP.NET Core。
Go
  • 特点：由Google开发，简洁高效，适合构建大型系统。
  • 资源：官方文档。
  • 学习路径：基础语法 → 并发编程 → 网络编程。
Checklist
参考资料介绍

为了深入理解每门语言及其生态系统，推荐阅读官方文档、经典书籍以及参加线上课程和研讨会。同时，GitHub上的开源项目也是学习的好去处。

总结

选择正确的编程语言并制定合理的学习路径对于新手软件工程师来说至关重要。每种语言都有其独特的优势和应用场景，因此理解它们的特性并根据个人兴趣和职业目标进行选择是关键。通过结合理论学习和实践项目，可以有效地提升编程技能并为未来的职业生涯打下坚实的基础。

2.工具与框架的选择和使用

在软件开发过程中，选择合适的工具和框架对于提高开发效率、保证代码质量和满足项目需求至关重要。不同的工具和框架有其特定的优势和适用场景，因此理解它们的特点并能够根据具体需求做出明智选择是新手软件工程师必须掌握的重要技能之一。

核心要点

  1. 编程语言的生态系统: 每种编程语言都有其独特的生态系统，包括库、框架、IDE（集成开发环境）等。例如，Python以其丰富的库支持数据科学和机器学习，而JavaScript则广泛应用于前端开发。

  2. 框架的角色: 框架提供了一套预定义的规则和结构，帮助开发者遵循最佳实践快速构建应用。例如，React用于构建用户界面，Django适用于快速开发安全的web应用。

  3. 工具的重要性: 版本控制系统如Git，持续集成/持续部署(CI/CD)工具如Jenkins，以及自动化测试工具等，都是现代软件开发不可或缺的部分。

  4. 性能考虑: 选择工具和框架时，需要考虑其对应用性能的影响。轻量级的框架可能更适合资源受限的环境。

  5. 社区和支持: 一个活跃的开发社区可以提供大量的学习资源、插件和第三方库，同时也意味着更多的就业机会和支持渠道。

Checklist
参考资料介绍
  • 官方文档: 始终是学习任何工具或框架的第一手资料。
  • 在线教程和课程: Udemy, Coursera, Pluralsight提供的视频课程可以帮助快速上手。
  • Stack Overflow: 解决具体问题的好去处，可以找到许多实际问题的解答。
  • GitHub: 查看项目的star数和fork数，了解项目的流行程度和活跃度。
总结

作为新手软件工程师，在选择工具和框架时，应该综合考虑项目需求、个人偏好、团队能力和长期维护等因素。通过不断实践和学习，逐渐建立起自己的判断力，以便在未来的项目中做出更加合理的决策。记住，没有一种工具或框架适合所有情况，关键是找到最适合当前项目的解决方案。

3.使用AI工具

在当今软件开发领域，人工智能（AI）技术的融入已成为推动行业发展的重要驱动力之一。对于新手软件工程师而言，掌握如何有效利用AI工具，不仅能够显著提升开发效率，还能促进创新思维的培养，使开发者能够站在更高的起点上参与复杂项目的开发与优化。本节将深入探讨AI工具在软件开发中的应用价值，以及如何将其作为强大的辅助手段，加速从理论到实践的转化过程。

核心要点

  1. 代码生成与补全：现代AI工具，如GitHub Copilot、TabNine等，能够基于上下文自动生成代码片段或提供智能补全建议，极大地提高了编码速度和准确性。这些工具通过深度学习模型训练，能理解自然语言注释和已有代码逻辑，从而辅助开发者快速完成编码任务。

  2. 自动化测试与调试：AI驱动的测试工具，例如SmartBear的TestComplete或Appium，能够自动执行测试用例，识别潜在的错误和性能瓶颈。它们可以模拟复杂的用户交互场景，比传统手工测试更高效地发现缺陷。

  3. 需求分析与设计辅助：通过自然语言处理技术，AI可以帮助解析需求文档，提取关键信息，甚至直接转化为初步的设计模型或伪代码。这有助于确保需求的准确理解和快速响应，减少沟通成本。

  4. 性能优化建议：AI工具能分析代码库，识别出低效或冗余的代码段，提出优化方案。例如，DeepCode可以利用机器学习算法评估代码质量，并提供改进建议，帮助开发者提升应用性能。

  5. 知识管理与搜索：随着项目规模的增长，维护庞大的代码库和文档变得日益困难。AI搜索引擎如Kite或KitchenSink，能够理解查询意图，快速定位相关信息，包括API文档、Stack Overflow答案等，极大提升了信息检索效率。

Checklist
参考资料介绍
  • 通义灵码
  • GitHub Copilot官方文档及社区案例研究，了解实际项目中的成功应用实例。
总结

对于新手软件工程师而言，合理利用AI工具是适应快速发展的技术环境、提升个人竞争力的关键。通过上述核心要点的实践，结合持续的学习与探索，可以逐步建立起与AI工具协同工作的能力，从而在软件开发的道路上走得更远、更稳。重要的是要认识到，AI工具虽强大，但人的判断力、创造力和团队协作仍是不可替代的核心价值。因此，平衡技术辅助与人类智慧，将是每位软件工程师成长过程中不可或缺的课题。

引用信息

引用本文请注明以下信息。

@article{lj_new_ser2024,
  author = {龙军},
  title = {新手软件工程师须知},
  year = {2024},
  url = {https://jdragonnudt.github.io/inspiraHub/myblog/posts/new-to-software-engineer/},
}

参考文献

丁丛丛，靳冉. 2021. “这就是软件工程师.”
Back to top