通識教育中心

 

 

【PART I 中文科技寫作工作坊】
同學們未來希望擔任工程師嗎? 不過是不是內心覺得「我只想好好寫 Code，不想寫技術文件」，但良好的國文能力，對工程師的職涯是很有幫助的！工程師除了開發完功能，還需要撰寫技術文件（ex：API 文件、測試報告），幫助開發人員日後回憶。

－－－－－－－－－－－－－－－－－－－－－－－－－－－－

主題: 【專為軟體工程師打造的技術寫作課】
時間 : 4/30 (二) 10:00-12:00
地點 : 先鋒國際研發大樓 601 教室
講師 : 知騏然有限公司負責人 朱騏老師

 

 

 

 

 

 

 

 

文/資安所碩一/陸紀霖

參加朱騏老師的技術寫作課程後，我對於技術文件的理解有了翻天覆地的改變。在這次演講中，朱騏老師以其深厚的專業知識和生動的示例，讓我深刻體會到技術文件背後的藝術。而最讓我印象深刻的，莫過於他分享的技術文件六元素及相關範例。

一開始，當朱騏老師提到技術文件六元素時，我並沒有意識到技術文件的編寫可以如此系統化和有條理。選單、摘要、前提、CTA、大綱和搜尋，每一個元素都有其獨特的功能，共同構成了一個完整的技術文檔架構。尤其是摘要和CTA，摘要不僅是對文件主題的總結，更是讀者快速了解文件內容的窗口，而CTA則能夠引導讀者採取下一步的行動。這些元素不僅為技術文件提供了清晰的組織結構，也為讀者提供了方便快捷的閱讀體驗。

更讓我驚訝的是，在演講中展示的技術文件範例。老師以自然輸入法和Cypress Guide分別提供寫得好的例子與寫的有許多改善空間的例子，我第一次意識到一份優秀的技術文件背後需要精心設計的結構和布局。一份好的文件不僅提供了必要的概念和任務，還通過引用參考連結和提供操作步驟的方式，讓讀者能夠從多個角度深入了解相關主題。這種多層次的框架設計，若沒有在這堂課學習到，我想必是寫不出來的。

除此之外，老師安排了小組討論的環節，以編寫70歲老人設計的計算機app文件為例，通過親自撰寫文件，我們不僅能夠更好地理解文檔框架的邏輯結構，還能夠更清晰地把握如何將技術知識具體轉化為文本信息。我們也有機會與同學們分享我們的編寫成果，並從他人的作品中學習和借鑒。這種互動式的學習方式不僅促進了我們之間的交流與合作，還激發了我們對技術寫作的興趣和熱情。通過與他人討論和比較，我們能夠更全面地了解不同風格和結構的技術文件，從而提高自己的寫作水平。

最後，每個小組都有機會向其他組分享自己的成果，並接受來自其他組的建議和反饋。這種相互分享和交流的過程不僅擴大了我們的視野，還使我們更加深入地理解了技術寫作的藝術。通過聆聽他人的意見和建議，我們能夠更客觀地評估自己的文檔，發現其中的不足之處，並進一步完善和改進。

總的來說，這次練習讓我深刻體會到了真正的學習是通過實踐和反思來完成的。僅僅掌握技術寫作的理論知識是遠遠不夠的，我們還需要通過實際操作和與他人的交流來不斷提高自己的寫作水平。感謝朱騏老師提供這樣一個寶貴的學習機會，讓我更加深入地理解了技術寫作的本質和精髓。

 

 

 

 

文/化工一甲/林淑婷

這場演講讓我知道一份完整的技術文件應該要考慮什麼，針對需要的讀者，讓他們在讀這份文件時，不會在網站裡迷失方向，能夠有效率的達到省時及快速的進到自己需要尋找的那方面，這樣也可以讓讀者有下次再次瀏覽的意願。首先裡面必須要包含的六元素，分別是選單、摘要、前提、CTA、大綱、搜尋。我們這組負責的是檢視技術文件中是否有完善的CTA，CTA就是Call To Action，讀者看完文件後下一步要做甚麼，在技術文件中就是下載程式的網頁，其中老師讓我們看第一份文件，經過多次找尋，發現並沒有CTA，在其他的元素，這份技術文件也有很明顯的缺失及讓人感到迷惘，這就是一份不好的技術文件，在第二份文件中，我們可以很明確地找到下載程式的網頁，同時還有其他遇到困難的解決辦法，這樣讓有特殊需求的讀者可以達到省時又省力。

接下來是技術文件的結構，包含概念、任務、參考連結，包含了1.讀者瞭解這份文件後得到的好處及成果。2.必須先完成的任務，才能進行操作。3.任務標題的公式：如何+動詞+受詞。4.假設讀者使用的場景。5.相關概念。舉例來說：一份使用計算機的技術文件，長輩了解這份文件可以在計算日常生活支出、買菜，達到省時方便不容易出錯，必須先下載程式才能進行操作，任務標題我們就可以使用到如何+動詞+受詞的任務標題，例如：如何使用加減乘除，最後可以加上其他相關功能或概念，例如：如何使用記憶鍵。這樣結合下來就是一份有一定完善的技術文件的結構。

經由這場寫作工作坊，除了讓我在分組活動中可以認識其他同學，共同分工合作完成事情，此外也對於技術文件有更多的認識，還沒聽這場演講前，看了演講的題目，讓我對於這場演講感受是當興趣摸索，專業領域能用到的機會渺小，經由參加這場演講後，在化工領域上未來職場上一定會有需要開發、研究的產品，這份技術開發的技術文件，有可能就是我們需要提供給客戶的解決困難的網頁，而了解技術文件的架構、內容、清楚如何排列，做出一份技術文件，使讀者更方便的找到他的方向。

 

 

 

 

文/創新AI碩二/陳明君

今天我有幸參加了由朱騏老師專為軟體工程師設計的技術寫作課程，整場課程持續兩小時，深入淺出地介紹了許多業界的精要技巧。課程採用翻轉教室的方式進行，使每位同學都能積極參與到課程內容。在小組討論的環節，我從其他組員的分享中獲得了不少靈感，看到了許多不同的觀點和想法，這種互動式的學習方式讓我體驗到全新的學習樂趣與價值，非常推薦大家嘗試。

其中，我學到最印象深刻的是一份優質技術文件應包含的六大要素：選單、摘要、前提、呼籲行動（CTA）、大綱及搜尋功能。這些元素對於文件的結構性和完整性至關重要，缺一不可。回顧以往，我在撰寫技術文件時往往過於追求專業性，結果不僅使文件變得枯燥，也降低一般使用者的閱讀性。然而，今天的課程中，朱騏老師不僅教導了理論知識，更引導我們透過撰寫貼近日常生活的例子來練習，使技術文件不僅專業，同時也富含趣味性，更能吸引使用者的注意力。

課程中的另一個重要部分是案例分析，老師選用了多個不同領域的實際技術文件，讓我們分析並討論其優點與不足。透過這種方式，我們學到了如何識別並應用好的寫作實踐，以及如何避免常見的錯誤。這不僅增強了我的分析能力，也讓我能夠更自信地評估和改進自己的寫作。

此外，這次技術寫作課程還特別強調了讀者導向的寫作策略。老師多次提到，一份成功的技術文件應該能夠即刻吸引目標讀者的注意，並直接解決他們的疑問或需求。這意味著作為技術寫作者，我們需要從使用者的角度出發，考慮他們在接觸產品時可能遇到的困惑和問題，並提供明確、易懂的解答和指導。這種以讀者為中心的寫作方式，不僅提升了文件的可用性，也增加了文檔的互動性和實用性。

這種寫作方式的經驗分享，對於一般軟體工程師很有幫助，是大家都應該了解的基礎。在我從事軟體開發和產品測試的實習經歷中，離不開這些核心架構，在實習的過程中沒有人帶領，只好自己不斷翻找資料，從眾多文件中找出優點仿效，如果在就職以前就具備這些基本知識，就能使工作更快上手。

最後，朱騏老師也提到了持續學習和自我提升的重要性。在技術迅速發展的今天，持續更新自己的技術知識和寫作技巧是每位工程師不可或缺的職業發展路徑。透過參與此類課程，我不僅學習到了實用的技術寫作技巧，更加明白了作為一名專業人士，應持續追求知識和技能的提升。