一般工程简介/文档
除非其他人能够在没有你的情况下...没有你的指导...没有你的人格存在的情况下...复制你所做的事情，否则你不能算是一个工程师。
工程文档主要有四种形式：笔记本、项目、教程和演示。以下重点介绍项目文档。项目文档是电子的，分为两类：个人和团队。
制作是指设计师直接制作文物。这没有文档。其他人无法制作文物。埃及金字塔、万里长城、玛雅神庙都是制作出来的。展示、交谈和实践与工程无关。因此，我们今天只能推测它们是如何建造的。
贸易或手工业经济在没有文档的情况下已经存在。没有工程师。现代世界依赖于工程师的文档。
历史上存在着许多天才，未来也会有。但如果没有文档，没有人能够修复、改进、复制或解释。如果没有文档，天才的成果将消失。
复制是工程文档的主要目标。
复制涉及为两个截然不同的受众记录：技术人员和其他工程师。技术人员希望能够准确地重复你的步骤以获得成功，这导致了教程的产生。工程师将阅读这些教程以更快地了解技术的未知边缘。但工程师还需要其他东西。他们想知道团队是如何组织起来进入未知领域的。工程师想知道如何识别死胡同。工程师想知道导致失败的症状、错误信息和故障模式的详细信息。工程师想知道任务是如何分配的。这被称为项目或问题文档。
文档可能比材料更昂贵。现在的飞机都是没有进行实物世界测试就制造出来的。有关飞机的信息创建了模拟，现在这些模拟能够准确地预测成功。一些农作物的资讯成本超过了种植和收获的成本。山核桃的采摘、脱壳、去皮、干燥和包装的成本低于运输成本。资讯（包装、运输、营销、支持、生命周期）也需要工程设计。工程服务或软件纯粹是工程资讯。这就是为什么一些工程入门课程只对文档进行评分，而不是对实物成功进行评分。
人员、时间、动手经验都很昂贵，而且越来越昂贵。能够在没有实物建模、没有购买套件、没有大量破坏性测试的情况下进行设计的工程师将会更加成功。
政府强制要求某些工程学科对所有设计文件进行检查。美国的专业工程师拥有一个浮雕印章，用于在经检查的文件上盖章。
工程文件必须创建。有时它们有成千上万页。参与其中的工程师主要有三个群体：代表政府利益的工程师、设计桥梁的工程师和建造桥梁的工程师。同一家工程公司只能做这三项工作中的其中一项。这促使了文档的创建。工程文档成为项目的根基、起点和核心，而不是单个工程师。这些法律和程序实践促进了土木工程文档的演变。
更新的工程学科似乎不得不重新学习这种道德准则。一个人的思维无法考虑到所有需要考虑的可能性。一个人也无法轻易地从创造性思维转变为详细检查的思维方式。才华无法消除这种需要。一个“贷款发放”软件包被银行分支机构拒绝了。问题是？该软件是由一位天才工程师“制作”的。
只有在从一位工程师转移到另一位工程师时，设计文件才会脱离相关人员的个性而发展。在软件工程领域，结对编程和单元测试的纪律实践正在探索检查方法。
必须挖掘一群工程师的集体智慧。孤独的天才工程师可以被发现，他们在一些试图建立专利组合的公司中被隔离和独自工作。但这很罕见。必须收集所有工程师的意见，包括公司之外的工程师的意见。收集意见、建议和资源需要一个团队工程师共同完成项目文档。
只有在从一位工程师转移到另一位工程师时，“最佳实践”文档标准才有机会发展。开源软件开发是软件工程的开始，因为它为软件文档提供了一个起点。软件很重要，因为如今所有工程的很大一部分都围绕着模拟、数据收集和分析。使用任何软件包都涉及某种形式的编程。
每家工程公司都有自己的项目文档方法。失败的项目、开放式项目和正在进行的工程项目与“成功”项目的文档方式非常不同。成功的项目文档很快就会变成操作理论、维修手册、操作手册等。本课程的目标是在大学一年级工程专业的背景下教授工程文档。
一般工程项目的目的是用以下目标来捕捉工程的创造性设计过程：
- 其他人可以加入，找到一个起点，并将项目推进
- 现有文档作为脚手架，可以快速建立专业知识
- 项目经理/讲师可以查看以前的任务演变、时间和消耗的材料，以便进行计划
- 让非专业读者/其他工程师有机会阅读问题并提出解决方案
- 成为特定类型项目的最佳实践实施方案
你需要在两个地方对你的工作进行电子记录。你需要两种类型的信息在你的指尖。一种类型可以在互联网上找到。另一种是个人且安全的。你的实物笔记本是最终的安全保障。你需要创建自己的安全个人电子文件存储库的原因有很多
- 互联网信息瞬息万变，您可能需要一个过去的快照。不要依赖于互联网档案馆。
- 大多数人把自己散布在整个互联网上。四年后，在求职面试中，你真的能够找到你在 Facebook 上发布的酷炫帖子，或者你写在别人博客里的回复吗？
- 工作会找到你。公司会查看你的在线作品集。
你写的每一篇论文，你画的每一幅画，你上的每一门课程的教学大纲，你扫描的每一份作业问题，你收集的每一比特数据，你创建的每一项模拟，你编写的每一个程序的每一个版本，你创建的每一份简历，你拍摄的每一张照片和视频，都需要触手可及。将来你会需要它们。那些拥有这些信息的人会得到更好的工作，参与到更好的项目中，并减少对证书和学位的担忧。有些人认为，大学教育体系将从学位转向作品集。你需要开始收集构建作品集所需的原始资源。你可以在哪里以及如何做到这一点，可能是
- 硬盘驱动器（硬盘驱动器最终会损坏）
- U 盘（这些最终会被丢失或感染病毒）
- 学校创建的个人文件夹（当你毕业或不支付账单时会消失）
- 互联网云：谷歌云盘、Dropbox（或竞争对手）（担心隐私、免费服务消失）
没有完美的答案。最好的前互联网工程师也可以立即找到所需部件的正确目录，所需解决方案或类似过去项目的文档。在互联网出现之前，不是拥有最佳思维的工程师，而是拥有最佳纸质组织系统的工程师获得了最大的尊重。现在，最受尊敬的工程师可以找到 3 年前的电子邮件附件。
截至 2014 年秋季，这是最佳实践。
- 如果你拍的照片，请上传到维基共享资源
- 不要将合理使用 他人的图形作品上传到维基教科书
- 创建一个维基教科书 ID，并在维基用户：空间中建立一个个人资料
- 在维基用户空间中进行所有编辑，完成后再转移到维基教科书文章空间
- 将视频上传到 YouTube，创建带有“视频”字样和视频描述的公共链接
个人周报
[edit | edit source]个人周报以维基格式完成，并在维基教科书中进行。
个人周报的评分分为三个部分
- 形式…电子文档以叙事形式链接，遵循维基格式
- 沟通…为团队创建每周任务，对每个团队成员进行正面评价，完全透明，以便经理能够看到谁做了什么
- 工作…推动项目向前发展，而不仅仅是在个人学习曲线方面工作，以及/或者帮助在维基教科书页面上创建设计文档
工作点数是用于“推动”项目向前发展和设计。这意味着做一些有意义的事情。这是个人认可和奖励。推动点数与努力工作、金钱、大量时间、失败或成功无关。推动点数是根据详细记录、所采取的步骤以及花费的时间来授予的。失败将导致更多点数。成功通常会产生教程。
对本周发生的事情进行口头总结不会给你任何推动点数。例如，写下“我尝试运行 Android 战斗控制器，但失败了”，不会给你任何项目点数。问题不在于失败，问题在于没有描述失败。在哪个计算机的哪个虚拟机上，运行哪个版本的 Android 操作系统和哪个战斗控制器？错误信息是什么？找不到 Wi-Fi 还是无法访问 SD 卡？注意失败，并开始提出 1000 个关于它的问题。
所有失败、所有文档都将进入与讲师协商的 CDIO 文档。CDIO 文档的名称，它的纲要，就是所有项目文档存放的地方。大多数情况下，该文档将由一个人创建。团队中的每个人大部分时间都会处理一份 CDIO 文档。然后，它将由团队成员进行检查，并由团队成员在团队完成时授予发布权限。
大多数 CDIO 文档内容来自你的笔记本。你笔记本中写下的混乱和挫败感被整理起来，并简化为简短的旁白。你在笔记本中写字时拍摄的照片和视频随后被组装成 CDIO 文档中一个引人入胜的故事。
通常情况下，形式和合作点数有固定的最高值。推动点数没有限制。推动点数可占课程总成绩的 10%。
同行评审
[edit | edit source]对你的团队成员说一些关于他们自己的积极的话。练习赞美。计划它。不要指望它在你心情好的时候会自发地从你的灵魂中迸发出来。
大多数学校都有一个支持服务系统，当学生停止参与时，该系统就会启动。如果团队成员不互相关心，大多数这些服务都是无效的。遇到问题的人往往寻求帮助太晚。由团队成员来触发这些服务。如果一个团队成员没有工作可供审查，请与他们沟通。将此事转告给讲师，以便学校的支持服务能够做好他们的工作。
团队
[edit | edit source]我们
[edit | edit source]CDIO 文档的目标是隐藏个性。从“我们”的角度来写它们。你可能会得到几年以前或昨天别人的 CDIO 文档来进行改进。一些 CDIO 文档由几个人同时进行。
工程公司通常在团队成功时奖励工程师。公司内的个别工程师是公司秘密的、宝贵的、隐藏在公众视野之外的资产。
许多工程项目可以无限期地继续下去。它们可以分支、分叉、改变方向以及合并。文档也是如此。任何以“我”的视角写的东西看起来都不合适。
工程项目永远不会完成。总是有可以想到的下一步。但是项目文档有明确的界限。这些界限是由项目经理设定的，他们试图预测时间、材料、人员、资金和空间。这些资源在业务方面结合在一起，形成了与利润相关的完成定义。“足够好”捕捉了这种类型的“完成”。
项目文档是工程师将项目责任传递给另一个团队的方式。工程项目永远不会“完成”。每个工程团队通常只完成一个更大、多团队或多年项目的很少一部分。
本课程的目标是在项目上以平稳的速度工作。不鼓励在最后一刻或第一周快速完成项目。
项目文档的最小纲要可以在维基教科书中找到。
项目成功
[edit | edit source]如果一个项目解决了问题陈述中描述的问题，那么该项目就被认为是成功的。问题陈述是一个可以修改的流体文档，需要征得客户（或讲师/项目经理）的同意。
设计
[edit | edit source]工程设计是本书的下一个主要部分。它们首先被大致地组织成艺术、科学和商业类别。最终，这些类别之一将主导一个工程项目。首先学会用这些术语思考，而不是机械、电气、土木、化学或生物工程。
设计中的纸质工作/文档部分侧重于CDIO，它列在商业部分，工程公司“尚未成功…失败”的工程文档是其隐藏的价值。在这种情况下，个人和团队在创建 CDIO 文档时可以执行更具体的任务。