模型 多型 接下來將使用在 [Day 06] OpenAPI：標準的 API 描述技術規範(五) 時相同的情境做說明。會員允許多種登入方式，而透過不同的登入方...
模型 使用關鍵字 model 建立模型，模型可以在不同的操作或其他模型中重複使用，編譯時模型會輸出在 components 節點，並在各個使用的地方透過 $r...
今天將介紹 TypeSpec 的基礎型別，接著說明如何將其使用在操作的參數和回傳中。 型別 數值 和 OpenAPI 一樣，TypeSpec 支援許多不同的數...
命名空間 在 TypeSpec 中可使用命名空間 namespace 來分類類型，透過這樣的方式可以組織不同類型，也可以避免命名衝突，範例程式碼如下： nam...
在開始之前，先簡單介紹一下昨日我們建立的專案及基本操作。初始化 TypeSpec 專案時產生的 main.tsp 檔是 TypeSpec 的預設進入點，CLI...
手刻 yaml 或 json 文件讓寫 OpenAPI 文件相當不方便，透過 Swagger Editor 或 Stoplight 等 UI 輔助工具是一種選...
一般在做 API 設計時，都會盡量收斂設計，期望一組 API 不用太多支，每支 API 參數和欄位不要太複雜，希望這些 API 可以像最經典的樂高積木一樣小而...
在多數的情境下，不會獨立存在一支 API，而是由一組 API 來對領域或資源進行存取，以會員服務來說，會有一組包含：註冊、異動、註銷、取得單筆、查詢多筆......
OpenAPI 的資料型別(type)是基於 Json 擴充，基礎型別有 boolean、integer、number、string......等，並可藉由...
完成服務的基本描述後，就可以針對各支 API 內容進行撰寫了。同樣以虛構的會員服務為範例，以下是一支「取得單一會員資訊 API」的 OpenAPI 規格： #...
昨天探討了 Web API 文件要有的內容，OpenAPI 提供了標準化的規範，讓開發者能夠以 json 或 yaml 格式來描述 API 規格。不少開發者都...
我：「我不想寫文件！」也是我：「為什麼沒有文件！」身為一個 Web 後端工程師，既然不可能不寫文件，如何讓文件更好寫？本系列文將針對 Web API 的文件撰...
Word 跟Power Point 一樣，是個擁有多種功能的軟體，小的時候我甚至拿Word 來做過網頁。如果你使用Word 的目的跟我一樣是為了要用來製作印刷品...
當文件做得差不多了，目錄都插入完畢後，此時可以開始加上封面了。今天來如果要做封面我會怎麼執行，以及維持內容都從右頁開始的方法。 製作封面 封面的製作一率從「插入...
講完頁碼終於要來講目錄了，我想應該有很多人以經學會自動產生目錄了但是關於目錄的設定跟更新方式，我還是想花點時間來分享。 新增自訂目錄 在整份文件的最前面新增一...
當交付給RD單位進行開發，到最後交付死線後則進入驗收測試階段，開始進行驗收的程序，至於驗收測試的程序該怎麼執行每個產品定義，又或專案團隊因產品屬性不同而導致規則...
昨天我們提到了頁首和頁尾，今天我們就來仔細說說這部份。 頁首頁尾 頁首和頁尾是WORD頁面上下的空白區域，通常是邊界以外的地方（但也可以透過設定擴大），我們可以...
在Word 當中，遇到分節符號表示已經踏入進階的排版層次，或者說，恭喜你開始排版一些具有複雜度的文件了。 分節符號基本介紹 分節符號的用意是讓整份文件分出章節，...
大多數的時候，我們都使用 A4 橫排進行排版和印製，但Word 當中提供各種不同的版面設定可以使用，今天我們來看看有那些可以設定。 大小 除了直接從上方的「版...
上大學之後寫報告的時候，老師都會要求我們加上圖表標號，想必大家對於這個功能很熟悉，因此我們今天直接秋入如果報告格式要求要「有章節的圖表標號」，例如：圖1-1，...
繼續跟各位分享有關開會相關的經驗，今天分享開會中的會議紀錄，昨天提到的掉進會議輪迴也不需煩惱，除了善用開會中的時間利用之外，將會議中的對話發言決議記錄下來，而這...
表格應該是大家在Word 中很常使用的一項工具，想必大家都很熟悉一些基本的設定方式，我就只分享幾個我曾經翻過車的地方。 儲存格邊界 製作一個表格，會注意到表格的...
美國第十六任總統林肯(Abraham Lincoln)曾說過與專利有關的名言：「The patent system added the fuel of inte...
今天分享的是標號清單跟跟進階的多層次清單，會了這個之後配合樣式，就可以形成一份看起來很專業的報告模板。 標號 項目符號與標號清單兩個功能大家應該不陌生，在常用...
在專案管理中如同聖經一般的典藏文件，八九不離十應該就是「白皮書」(White Paper)。白皮書的定義：英國下議院的報告文獻，對某些問題概略的陳述其政策及立法...
14 - 【WORD】大綱階層 在段落的設定中有個大綱階層的功能，可以為段落設定所屬的階層。 階層1為最高的大綱階層，依序向下遞減，而「本文」則是不算在大綱裡的...
做為一位PM所轄管理了眾多各單位，而其中產品的開發核心RD單位需提供相關開發需求，並須要求RD單位必須依所提供訂立的需求規格文件做開發，於每checkpoint...
接下來的幾天會跟各位分享各類系統相關或內部會用到的實用文件，以簡單描述實例帶大家了解擬定或撰寫系統文件如何接入重點，詳細地描述專案所需的格部分，以便於團隊同仁參...
Word 篇的開頭，讓我們從名詞解釋開始。剛開始學習 Word 的時候其實不太需要了解這些名詞的定義，但是瞭解這些名詞的意思之後讓我的學習過程變得更加順利，有些...
紙上談兵的「紙」-文件(documatation)，於專案管理過程中，常被忽略或是很不起眼，但它卻有記載著專案前世、今生與未來(BNA；Before Now a...
Kei Liao
Shell
Leodaddy
iThome鐵人賽
看影片追技術