跳轉到內容

通用工程介紹/教程

來自華夏公益教科書

測驗

實際的 教程 存在!

對一個人來說,日常的、簡單的事情、常識性的東西,對另一個人來說是神秘的。一個叫不出螺絲刀名字的人,會對所有這些技巧感到迷惑。玩弄 PID 軟體對那些沒有學習過控制課程的人來說是個謎。 優秀的教程 需要寫作技巧。開始寫教程並不需要。

專案支架

[編輯 | 編輯原始碼]

支架是指講師透過講課來推動專案前進。講師可能只是在黑板上寫字。講師可能會發放講義或提供動手活動。講師可以單獨進行,也可以對團隊或整個班級進行。重點是,講師這樣做並不是為了建立教程。從這種練習中受益的人或團隊被期望將講座變成教程。

專案支架的目標是儘快掌握最新資訊,以便能夠高效地推動專案前進。如果沒有支架,大多數學生會把所有時間都花在學習專案上,而不是實際做專案。

大多數大一和大二的工程專案並不是關於支架的。目標是教授設計和解決問題的技能。內容只是為了服務於這些目標。

除了講師,其他工程師,甚至學生,可能也會有一些寶貴的資訊可以幫助你推動專案前進。你的目標是捕獲、擁有,然後將這些資訊傳遞給世界。否則,這些寶貴的資訊就只會停留在人們的腦海裡,在不同的大腦之間口頭傳遞,並受到空間、時間和語境的限制。

例如,一個講師親自演示如何測試 Arduino 是否正常工作。你可以開啟 ardenialin 並記錄下每一個按鍵,讓講師放慢速度,強迫講師和你說話,而不是在鍵盤上飛來飛去。你可以讓講師向你展示什麼是可能的,你將自己弄清楚細節。

你應該做的是,不要對自己說,“哇,講師知道這個,所以我不用學。當我下次需要這樣做的時候,我可以再問他”。不要對自己說,“可能每個人都知道這個,我真是個傻瓜”。不要對自己說,“所有的工程師都知道這個,所以我問問其他講師或助教就行了”。工程師不會參與群體思維、群體意識、群體知識。群體思維會矇蔽工程師。群體思維會讓所有工程師都變得一樣。平庸開始佔據主導地位。

不要指望透過利用集體智慧來成為一名工程師。當一個工程師在和你說話時,把它當作一份禮物…一份獨一無二的禮物,只有工程師知道,並且正在傳授給你。如果有人在白板上塗鴉,而你的團隊中沒有人把它寫下來…無論對錯,是否合乎目標,是否有用,都應該把它記錄下來,最終將其納入團隊文件中。

何時支架和教程不好

[編輯 | 編輯原始碼]

當一個問題非常頑固時,最好不要尋找教程或支架。頑固的問題是那些其他工程師已經嘗試過但沒有解決的問題。傾聽他們的故事,閱讀他們的嘗試,會讓那些剛接觸這個問題的工程師感染上同樣的病毒,矇蔽他們之前的工程師。當目標是截然不同的東西時,需要來自截然不同背景的工程師…沒有現有的支架/教程。另一方面,如果目標是逆向工程,如果目標是複製,那麼支架和教程是絕對必要的。

真正有藝術感的工程師會拒絕記錄,因為他們認為下一代工程師應該自由地創造全新的東西。然而,這不是工程師的特權。這是客戶的特權…就是支付工程師工資的人。

當你不知道怎麼做的時候

[編輯 | 編輯原始碼]

歡呼吧。你將要學習一些新東西。你將要擴充套件你的工具集。你將要成為一名更有價值的工程師。你可能有機會先做一些事情。

如果你不知道如何做某件事,你應該期望存在一個優秀的教程來教你如何做。如果教程不存在,那麼這是世界的問題,而不是你的問題。更重要的是,你還有機會透過建立/編輯教程來改善世界。

假設你知道如何用焊錫穿孔,但對錶面貼裝焊接一無所知。什麼更有價值呢?

  • 一個關於這個主題的隨機 YouTube 影片
  • 或者一個影片展示如何使用你的學校積累的裝置

你的目標是根據隨機的 YouTube 影片建立教程。如果已經有了一個教程,你的目標是改進教程或快速瀏覽它。

優秀的教程

[編輯 | 編輯原始碼]

一個優秀的教程看起來像一棵樹。你從根部開始掃描,一直向上工作到葉子。一個優秀的教程意味著你沿著熟悉的樹幹向上移動到熟悉的樹枝,直到你找到一些新的東西。你放慢速度,掠過一片葉子。也許這片葉子不是你想要去的地方。你退回到熟悉的地方,然後爬向另一片葉子。你繼續識別你不想知道的東西,直到你找到你想學習的東西。然後重新跟蹤你從熟悉的地方到目標葉子的路徑。在你完成教程的過程中,使用維基標記工具 編輯教程…而不是 事後編輯。

維基versity 教程

[編輯 | 編輯原始碼]

教程是維基versity 中的文章。華夏公益教科書包含分組到書籍中的文章。通用工程教程在維基versity 上被 分類。在維基versity 上有 最佳實踐 的方法來建立教程。

不是教科書

[編輯 | 編輯原始碼]

不要試圖寫一本教科書。不要試圖追溯到最初的根源哲學概念。不要試圖做到完美。記錄你的團隊為了成功而做的事情。不要擔心你的讀者。為你的講師而寫。如果你的講師能理解,你應該能得到一個好分數。讓其他遵循你的步驟的人改進教程。不要為自己而寫。你的邏輯、你的符號、你的天賦可能是獨一無二的。你的講師會更好地瞭解什麼是“完整”、“詳細”和“標準”。

不要相信教科書的章節是邏輯相關的。教科書通常是對主題的調查,它們透過一條非常薄的邏輯線索來組織順序。教程不應該以這種方式對待。

將教科書視為主題調查,就像搜尋結果一樣。跳到看起來相關的部分,然後開始閱讀。記下你不理解的詞語。開始對這些詞語進行分類,就像它們是謎題的線索一樣。建立到更詳細解釋的連結。

重複使用

[編輯 | 編輯原始碼]

教程是關於科學、數學或技術的。工具及其使用是技術的一部分。與工具以各種不同方式使用一樣,相同數學應用於各種學科。工程專案是設定教程使用和重複使用上下文的因素。預計教程圖片會被重複使用,並在一個教程與另一個教程之間形成多對多關係,而不是層次樹形模式。建立步驟的主頁,然後連結到步驟。理想情況下,其他人可以建立主頁,包括其他步驟或將步驟放在不同的位置,跳過步驟等。相同的步驟成為其他教程的構建塊。

捕獲學習曲線

[編輯 | 編輯原始碼]

並非所有人都遇到相同的挫折。並非所有人都卡在同一個地方。不同的人真是令人驚歎。不要以為你不會就認為自己很蠢。世界很蠢,很偏見,沒有預料到你的挫折。改變世界。改善世界。在忘記之前,透過立即修改教程來捕獲你的挫折。

不要等到世界或你自己的完美,才嘗試工程。

整理個人筆記

[編輯 | 編輯原始碼]

工程筆記本 90% 是錯誤的,因為它們記錄了工程師卡住的地方。閱讀工程筆記本讓人完全困惑。其他人的筆記本不是尋找教程的地方。

但是工程筆記本,如果在做的時候寫,就會包含建立教程所需的所有細節。教程步驟可能沒有順序。細節可能在 90% 的頁面上都是錯的。成果可能在一個頁面上的一句話中。組織這些資訊是教程的目標。

不要犯這樣的錯誤,試圖讓你的筆記本看起來像教程。

個人 wikiversity 頁面包含筆記本混亂的反思或擴充套件。資訊按時間順序排序,就像筆記本一樣,並擴充套件了圖片和連結。另一方面,教程是步驟或起點的列表。

建立佔位符

[編輯 | 編輯原始碼]

教程的確切細節很重要。建立最好的教程很重要。但教程細節並非最重要的東西。

大多數維基文章的細節來自一個人。其他人會來進行一些小的編輯。這篇文章可能會在其他人檢視它之前停留 5 年。而且他們很有可能會連結到它。

創造歷史。成為第一作者。透過準確描述教程的目標併為其提供相關的 wikiversity 文章名稱,為本教程建立一個佔位符。不要擔心它是否完美。其他人將在未來修復細節、澄清並新增內容。

教程/文章佔據了維基上的空間。它被連結。它的使用被記錄下來。個人而不是人群檢視它。在你所到之處添加價值的傳統……如果你能做到。既建立原創作品,也編輯他人的作品。

華夏公益教科書