iT邦幫忙

2022 iThome 鐵人賽

DAY 11
0

接下來的幾天會跟各位分享各類系統相關或內部會用到的實用文件,以簡單描述實例帶大家了解擬定或撰寫系統文件如何接入重點,詳細地描述專案所需的格部分,以便於團隊同仁參考運用。

各方都會懂得的API文件

通常RD會提供或是PM必須要求生出一份規格文件,然後再將這份規格文件消化後用大家可能會比較聽得懂或看得懂的方式用圖片與文字將他記錄下來成為一份專業的參考文件。當cloud團隊已經在雲端架設好相關功能也寫好呼叫程式,並寫成API供外部去串接,這時候產品網站設計團隊就必須去連cloud團隊有開放的API做串接,譬如:登入登出、忘記密碼、重設密碼、會員中心等基本功能,將RD提供的簡單API描述文件與網站架構作結合撰寫一份各方都看得懂的文件。

  • 網站串接使用API的工作流程架構

以最上位的觀點來看整個串接的樣貌,文字描述配合自己融會貫通的架構關係簡單繪畫出串接的工作流程架構。
https://ithelp.ithome.com.tw/upload/images/20220922/20142003W6pu2ilBhA.jpg

  • RESTful API於網站的應用

簡單概述RESTful處理方式。
https://ithelp.ithome.com.tw/upload/images/20220922/20142003RODzBj6Ul6.jpg

  • 網站會用到的API

用心製圖描述網站會用到那些API,並用不同的顏色表示不同的方法應用。
https://ithelp.ithome.com.tw/upload/images/20220922/20142003r9YdeLlgWS.jpg

  • 網站實際畫面與API應用關係

用實際功能的網站畫面,列出所對應的API。
https://ithelp.ithome.com.tw/upload/images/20220922/20142003dkB0EVye0O.jpg

看得懂最重要

系統相關文件簡單敘述加上圖片文字即可,主要是讓人一目了然,直覺洞悉彼此關係比較重要,因Leodaddy系統開發出身,所以相關RD文件spec看一下就大約可以知道所要表達的意思,很快地抓到重點就可以撰寫出來,另外,在專案管理的試煉場若也讓自己磨練成一位專業的系統文件寫手,好像算是另一種收穫XD。


上一篇
Day 10 專案管理的其他水晶球
下一篇
Day 12 文件加上隱私設計調味
系列文
掉進絕命專案管理的多重宇宙30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言