今天的文章不是一個技術文,反而是探討身為一個軟體工程師,該怎麼撰寫相關的技術文件
鑑於 WFH (Work From Hoem) 習慣的興起,人與人面對面的溝通減少,這意味即時的訊息傳遞變少了,取而代之的是非同步的訊息傳遞,簡單來說就是技術文件。
好的技術文件能夠讓需要的人快速找到問題,解決疑惑,但是一個好的技術文件到底該怎麼寫,這部分其實非常困難,並不是向程式碼一樣可以 copy&paste 馬上看到成果的,反而是需要時間練習,將整個過程與思路消化起來,用自己習慣的語言與形式將其撰寫出來。
首先,作者非常推崇由 Google 撰寫的系列文章,Tech Writing Course,整個課程內容不到兩小時,從不同章節來跟大家分享如何撰寫技術文章
接者撰寫技術文章時,作者個人是喜歡 divio 這個平台,不過更重要的則是其推薦的分類模式,根據內容分類成四大項
1. Tutorials - 學習導向
2. How-To Guides - 問題解決導向
3. Explanation - 深度理解導向
4. Reference - 資運分享導向
Google: https://developers.google.com/tech-writing
Divio: https://www.divio.com/
最後寫作語法方面,作者認為寫出一個能夠被有效搜尋的文章是非常重要的,譬如透過 word 等方式上傳檔案到系統中反而是一個不利於搜尋的方式。
取而代之的是,作者認為可以採用 Markdown 類似的語法作為基礎去撰寫文章,這種方式對於維護與撰寫都相對容易
今天有任何 Diagrams 的畫圖需求,可以考慮使用 Mermaid 這套解決方案,對於 GitLab/Azure 的使用者來說,已經內建其中。 GitHub/Atlassian Confluence 則有相關的 Plugin 可以安裝使用
最後則是文章的樣版內容,針對特定的文章格式,已經有不少的範本可以參考,透過這些範本可以更清楚的去描述你的內容,讓整體文章看起來更佳簡潔與流暢
1. Software Architecture Review Template
2. Architecture Decision Record Template
3. Incident Postmortem Template
4. DevOps Runbook
5. Decision Template
6. Writing Guidelines
7. OKR Template
8. Etc.
有興趣的點選原文學習更多
https://medium.com/better-programming/best-practices-when-documenting-your-code-for-software-engineers-941f0897aa0
「okr軟體推薦」的推薦目錄:
- 關於okr軟體推薦 在 矽谷牛的耕田筆記 Facebook 的最讚貼文
- 關於okr軟體推薦 在 椪皮仔 Facebook 的最佳貼文
- 關於okr軟體推薦 在 JC 財經觀點 Facebook 的最讚貼文
- 關於okr軟體推薦 在 搞定一切目标,个人OKR目标管理工具-Vision - YouTube 的評價
- 關於okr軟體推薦 在 OKR軟體2022-在Mobile01/PTT/Yahoo上的房地產討論內容及 ... 的評價
- 關於okr軟體推薦 在 OKR軟體2022-在Mobile01/PTT/Yahoo上的房地產討論內容及 ... 的評價
- 關於okr軟體推薦 在 工程師okr範例的推薦,PTT、DCARD和網路上有這些評價 的評價
- 關於okr軟體推薦 在 工程師okr範例的推薦,PTT、DCARD和網路上有這些評價 的評價
okr軟體推薦 在 椪皮仔 Facebook 的最佳貼文
「課程心得|鋒哥-學會OKR,在2021年快速成長」
先附上好讀版:https://vocus.cc/perspectivesofpon/5fe453bcfd897800018fa3a5
簡介一下OKR(Objective & Key Result),目標與關鍵結果。是用在企業或是個人設定目標並且執行的一種架構。
一、在寫OKR之前,要先搞清楚自己的目標是什麼:推薦『深度職場力』
這是我今年看到最好看的一本書,非常感謝朋友推薦。因為可能看我文章的很多人也是年輕人,因此非常推薦大家看一下這本書,感覺可以把在天空上的想法,拉到地面上來實行。
簡介一下這本書的作者 Cal Newport,是『深度工作力』的作者,但是這本書不是在教你怎麼在職場生活,而是告訴我們面對真正社會與職場時,我們應該要專注在什麼事情上?以及究竟要怎麼愛上自己的工作?
首先,開頭作者就告訴我們四個規則:
1. 不要追隨熱情
2. 技能的重要
3. 自主性的重要
4. 使命的重要
一、不要追隨熱情
在社群媒體上,充斥著因為擁有熱情而成功的藝人、富人、商人,讓我們的價值觀漸漸偏向『追求夢想=就能過上自己想要的生活』。
我不做,因為這不是我想要的生活;我不想,因為這不是我的熱情所在,甚至連選男女朋友都變成,我們不適合,所以不要在一起。那我們到底想要什麼?
我不知道,我只知道這不是我要的。我們不能知道我們想要什麼,但我可以知道我們不要什麼。這是我過去最常說的話,也是一般「熱情假設」的書籍所說的。
在過去的幾個月當中,我一直在尋找我的熱情所在。然而作者的第一句話就打臉我的想法,我立刻去買這本書來看,我想知道,為什麼作者會這麼主張。因為我跟作者所例舉的一般年輕人一樣,以為左思右想就會找到一個我會非常有熱情的工作,然後我就會從此跟賈伯斯一樣,發展出獨一無二的產品,成為一名成功人士。
但是這幾個月,我並沒有因為「找到熱情」這件事,讓我比較有方向,反而更迷惘、更焦慮了,也因為害怕自己所選擇的領域或是工作其實並非我的興趣,而一直駐足,不敢前進也不敢輕舉妄動。但其實,此刻最需要的正是『嘗試』。
後來我發現,當我認為我的某個行為或是言語對別人的生命產生意義的時候,我會感覺無比滿足。但是我不知道有什麼方式可以達到,我以為教英文可以,我以為做課程可以,我以為就是待在食品業不行,但是,其實這些都不是重點。
重點是要達到這件事情,需要的並不只有「熱情」。
前幾天我也看了博恩在Ted上的演講,他強調,興趣會驅使人沒有目的的去做一件事情,最終找到自己的去路,也讓他現在成為破百萬訂閱的youtuber,是不是就跟這本作者所主張的相反呢?「熱情」才是職涯的根本呢?
但反觀博恩在爆紅之前的生活,先不管他原本就是一個超級學霸,在下班之後仍然對自己的興趣不離不棄,並且刻意練習了六年以後,最終才在某一天突然爆紅。到底是因為熱情讓他能擁有今天的成就,還是因為那刻意練習了六年累積出來的實力呢?到底是因為原有的熱情讓他能堅持下去,還是在過程中不斷精進的實力,讓他更能堅持下去呢?
也就是說,我們需要的到底是一個「一開始就極度熱愛的工作」,還是「有點興趣,但做到頂尖之後擁有高度成就感、自主權而引起興趣的工作」呢?
二、技能的重要:讚到沒人可忽視你
作者提到「熱情思維」與「技能思維」最大的差異點。熱情思維是強調工作提供你什麼價值,而技能思維是強調你在工作中創造什麼價值。
「熱情思維」
作者提到,當你以熱情思維的基礎面對職場時,專注在工作能夠帶給你什麼,你會很在意那些不如意的事,然而剛入職場時的「基層工作」又是如此的繁瑣,不論是上司指派的任務或是組織官僚體系給人的挫敗感,都會讓你難以招架。第二個問題更重要,驅動熱情思維的深層問題(「我是誰?以及「我真正熱愛什麼?」)通常無法得到一個明確的答案,卻會讓人更加迷惘。
「技能思維」
作者認為:精彩的職涯往往會有錯綜復雜的起源,不是單憑追隨熱情就能開創出來。『你應該讓自己讚到沒人能忽視你』,別人自然就會找上門來。與其把時間花費在尋找自己到底熱愛什麼,不如找一個有興趣的領域,專注地把自己變強就好。
我的理解當中,作者並非否定「熱情」會對工作帶來正向影響,而是在剛開始進入職場的時候,就想要一步登天的找到自己的熱情所在並且配得上那個熱情,是很不切實際的。
作者也提到不適合套用技能思維的三項特質:
1. 那個工作沒什麼機會讓你培養珍貴稀有的技能,從而脫穎而出
2. 你覺得那個工作重視的東西沒什麼用處,甚至還對世界有害
3. 那個工作迫使你和討厭的人共事
也就是說,除了這三個特質必須避免,「把工作做好」比「入對行」更為重要。
那要怎麼「讓自己讚到沒人可以忽視你」呢?
1. 刻意練習:鎖定困難的活動、精挑細選演練的素材來挑戰自己最需要加強的地方,然後取得立即的意見反饋。
2. 建立五個技能思維者的習慣
a. 判斷自己是處在哪種職涯資本市場:贏者通吃市場(只要專注於一種技能的增進就好,多半為藝術或是創作類型的工作)、拍賣型市場(要有多種不同的職涯技能湊成獨特的資本組合)
b. 找出應該全力追求的資本:找到眼前那些讓你累積資本的機會,然後全力追求
c. 定義明確目標:這一步OKR就能幫上很大的忙了
d. 積極尋求挑戰與批評:刻意練習當中很重要的一部分是積極的徵詢意見反饋,即使那意見把你覺得「好」的東西批評的一文不值
e. 鍛鍊勤毅力:這邊所指的應該就是更常聽到的恆毅力。
三、自主性的重要:夢幻工作的萬靈丹
夢幻的萬靈丹:「在工作內容和工作方式上給予一個人更多自主性,可以增加他的幸福感、投入度和滿足度。」
作者提到「自主性」對於一個人的重要性,但是『自主性是要拿職涯資本來換的。』
也因為自主性的魅力,讓現在越來越多人想要投身成為一名「自由工作者」,因為不論是工作時間、工作內容,都能夠自由分配,擁有對工作的完全自主性。但是,往往擁有不夠多的職涯資本情況下的貿然追求更多自主權,會導致很危險的後果。聽過一個說法是,先待在一個工作好好的累積實力,等到兼職的收入能夠達到正職收入的兩倍時,才是你成為一名自由工作者的時候。
相同的,在職涯資本不夠多的情況下,貿然去「要求」更多的自主權,也是一個很危險的決定。作者舉到露露為例,露露第一份工作作為基層的「軟體測試員」,應該要是特別想掙脫無聊工作的一個職位,但是露露不但沒有這麼做,反而想辦法熟悉執行公司軟體得UIUX系統,然後自己學會寫程式化腳本,最後跟公司要求每周只工作三十個小時,去修哲學學位。如果露露沒有在公司努力讓自己讚到沒人能忽視你,反而在第一年的時候提出這個要求,那公司可能要你辭職算了。
四、使命的重要:小處著眼,大舉行動
使命,也像其他美好的特質一樣,你必須用職涯資本去交換;沒有職涯資本作為後盾時,使命注定曇花一現。
我認為我的使命是:所說的言論或是行為能夠對別人產生意義。是不是很抽象?就像作者說的,使命是很難以捉摸的。我們必須在接近頂尖的時候,看見鄰近的可能性,才有辦法真正的了解確切自己的使命,在接近頂尖以前,那個使命都是虛無飄渺。
作者強調:「使命的追尋,需要先壓抑我們對職涯抱持的浮誇空想,耐住性子,把發展的順序先搞對。」
作者也提到,嘗試了解自己使命的方式:打造出MVP(最小可能性產品)或是那項產品令人津津樂道或是在有助於眾人口耳相傳的地方發表。
回頭說說我,我今年想要達到什麼目標呢?
這邊先讓我前情提要一下介紹我自己,我目前的工作是在家中幫忙,家裡的公司是賣『火鍋湯底』的廠商,有麻辣、咖哩、泰式酸辣、昆布、牛奶等等口味,主要銷售給店家(to B)。 身為一個職業打雜小妹,我做的事情包山包海,但就是沒包到的就是『激起我的熱情』。
而我從小對教育產業很有興趣,覺得能夠幫助別人是一件很快樂,很有成就感的事情。因此我在今年一直在考慮想要轉換跑道,但由於我本科系也是念食品科學,轉換跑道等於放棄我的專業,因此,在要換與不換之間,我以為最重要需要決定的東西是『熱情』,但是我在找工作與看了這本書之後,突然覺得夢醒了。
如果你也是像我前幾個月一般迷惘,先不要想這麼多吧,我們一起讓自己先讚到讓人無法忽視,自主性、熱情、使命就會通通都來了。
二、要怎麼寫OKR?
詳細撰寫方式請見這篇文章『2021個人年度目標怎麼設定?三步驟OKR規劃法讓你KO目標!』,寫得非常詳細。
三、在執行時會遇到的困難
今天我要說的是則是我實際上應用遇到的困難,以及在鋒哥這堂課程當中解決的盲點。其實在上這堂課程以前,我就已經嘗試過OKR,但是卻常常變成牆上的一張裝飾品。
為什麼?以下我先列出過去執行當中的幾個問題點:
1. 一次想完成很困難的三項OKR,目標訂太高。
2. 想要將一個OKR執行到最後,因此目標或關鍵結果不斷再調整與修正時,會感到挫折與茫然。
3. 目標設定跟關鍵結果分不清楚。
4. 沒有持續對話和持續督促的人,一忙起來就會忘了這件事。
鋒哥的課程當中,解析了我的疑惑:
1. OKR有分兩種:登山型、射月型目標
登山型目標(期望分數為1.0,也就是必須要能達標)、射月型目標(期望分數0.7,也就是較為理想化的目標)
當然,我去年就是三個目標都設定為「射月型目標」,領域又橫跨了健康、寫作、語文、工作,所以執行起來極度容易放棄。
過去,我會想要專注把每一個領域都想達到最好。例如:把「英語學習」作為一個目標,去規劃聽說讀寫的整體計畫,但這往往不可行,一方面太累,二方面跟工作沒有太直接相關難以應用。因此今年我決定把目標放在「工作」上就好。但是在工作為目標去間接提升原本想要提升的其他能力。
例如:我一直想提升寫作與英語能力,我就將「公司未來想發展顧問服務」作為目標,大量閱讀國外與食品業及科技業相關的文章,一方面提升自己對於食品產業未來的發展,另一方面經過整理寫成文章訓練寫作能力,在這過程中也順便培養英語閱讀能力。
2. 個人使用OKR的五大關鍵
a. 找到可互相信任的mentor進行一對一對話
b. 認清真正重要的事,而非自己想做的事
c. 外在動機的目標,需要設置獎勵機制
d. 建立合作夥伴,跨部門分發任務
e. 累積並盤點資源,妥善分配
我以前認為,OKR就是一個目標,必須要徹底執行。但其實OKR只是一份拿來溝通的文件,真正重要的是「透過溝通,持續調整」。所以一位mentor是執行OKR最重要的元素,我也非常慶幸有很多老師都很樂意指導我QQQ,在此感謝所有恩師!
然而,明年,我會將OKR的精神執行,每週拿著OKR與老闆開會,確認我的目前OKR狀況與需要改進的地方,重要的是獲得回饋。與此同時,我也會常常詢問老師們,我遇到的問題,希望能夠再降低執行難度。
3. 目標與關鍵結果如何設定?
這個是整堂課的關鍵,鋒哥說,設定目標時應該要問自己:成功時,應該是什麼樣子?但是設定關鍵結果時,應該要問自己:要怎麼做才能達到成功?
對於目標:
a. 要感覺有點挑戰性與難度
b. 要注意目標是否有階級性,要先以某個階段目標作為目標。
c. 可以借用 SMART 、 ABCD 、5W2H 法則判斷
d. 推薦書籍:GOALS! 沒有目標,你哪裡都到不了!
以我在上課中的目標設定為例:
我原先的目標為「經營to B公司品牌,達到SEO第一名」
此目標有兩個問題:
1. 我的to B公司品牌目前有兩個方向想執行,一個為線下的業務拓展,另一個為線上的數位化經營。因此要經營公司品牌本身其實就是兩個不同的目標了,並不能放在同目標裡撰寫。
2. 如果是to B品牌的網站,所注重的並非SEO,而是關鍵字。我會想要重視SEO是希望未來能夠推出「顧問服務」,但是這跟原本的經營公司品牌又不是在同一個範疇內,因此我的官網也不該以「內容行銷」為主,而是應該研究更多SEM(透過付費來進行網路行銷,透過購買廣告的方式獲得的排名)。
所以我最終修改為:
「經營to B 公司品牌,提高30%營業額」
「經營to B 網頁,達到每個月XXX點擊率與XX轉換率」
對於關鍵結果:鋒哥特別強調關鍵結果不是to do list!
a. 不該出現諮詢、幫助、分析、參與等動詞
b. 應該要出現完成、公布等動詞
c. 要有具體的數量或可衡量的指標
d. 要有明確的結果,像是名單、文件、報告等名詞
e. 描述結果,而非活動
f. 關鍵結果要兼顧量跟質
針對我的目標「經營to B 公司品牌,提高30%營業額」的KR為:
a. 每個月拜訪10間火鍋業者並有兩間成交
b. 每個月洽談三間代理商,且增加一個通路
『其實這堂課最有價值的地方,就是可以在課堂上直接拿著自己的OKR請老師給我們建議,也可以聽到其他同學撰寫上的盲點,進而幫助我們釐清自身現況。』
很多朋友期待我分享這篇的心得,但我其實講不了什麼,因為每個人的目標都不同,我這個菜鳥也給不了什麼建議,所以如果老師有再次開課,建議絕對要去上!
找到人生方向很難,找到人生使命也很難,但是唯有『執行』才有可能讓這個方向越來越清晰,透過刻意練習累積實力,也在執行過程中不斷的向人請教,協助釐清盲點,相信幾年以後,我們都可以有足夠的職涯資本,選擇我們想要的路,幫助我們想幫助的人。2021年,也一起加油!
okr軟體推薦 在 JC 財經觀點 Facebook 的最讚貼文
周末還是應該來點好書推薦吧^^
1️⃣《投資超級英雄進化論》
投資超級英雄進化論之前是財信出版的,現在改由商周拿到版權好書重出。
投資學中的理論與實務是如何對抗與交融,形成一套特定且成功的決策模式,一直是市場中每個人追求的目標。在書中你可以看到這個過程是如何演化的,作者與每一位理論派,實務派的訪談紀錄讓你在腦中描繪出框架,對於應對市場中的已知與未知會有更深一層的想法。
2️⃣《OGSM打造高敏捷團隊》
實用的工具書,OGSM由Objective(最終目的)、Goal(具體目標)、Strategy(策略)與Measure(檢核)組成。
如何更優化OKR方法,加入更具體的GS,更有計畫的達到目標。書中有許多實例讓我們更能掌握這套流程,打造自己在工作與生活上的OGSM﹐
3️⃣《Google、臉書、微軟專家教你的66堂科技趨勢必修課》
包括軟體、演算法、雲端等各個主題,作者用簡單易懂的文字描述現在最需要知道的科技與趨勢,並且結合許多美股公司的商業模式討論,讓你瞭解這些科技如何變現。
其實這些討論應該都是現代人必備的基礎常識了,投資人可以更了解這些公司的競爭優勢,沒有投資的人也可以知道這些公司對你有什麼影響~
4️⃣《全圖解 全球商學院必修決策思維術》
在面對問題時,最重要的是懂得如何進行分類,並且利用適合的模型來分析,更高效的找出解決辦法。書這本書可以說是圖文並茂,討論了許多關於決策思考的方法,對於讀者來就很實用上手~
現在誠品書店和商業周刊合作舉辦全書系書展,兩書75折~大家可以參考看看摟!
https://eslite.me/M8CFU
okr軟體推薦 在 OKR軟體2022-在Mobile01/PTT/Yahoo上的房地產討論內容及 ... 的推薦與評價
OKR軟體 2022-在Mobile01/PTT/Yahoo上的房地產討論內容懶人包,找OKR tool,OKR App,目標管理App在YouTube影片與社群(Facebook/IG)熱門討論內容就來房地產即時資訊討論 ... ... <看更多>
okr軟體推薦 在 OKR軟體2022-在Mobile01/PTT/Yahoo上的房地產討論內容及 ... 的推薦與評價
OKR軟體 2022-在Mobile01/PTT/Yahoo上的房地產討論內容懶人包,找OKR tool,OKR App,目標管理App在YouTube影片與社群(Facebook/IG)熱門討論內容就來房地產即時資訊討論 ... ... <看更多>
okr軟體推薦 在 搞定一切目标,个人OKR目标管理工具-Vision - YouTube 的推薦與評價
00:00 Start01:49 一、什么是 OKR 管理法?03:32 二、Vision 的版本和界面05:36 三、在Vision 中创建目标09:22 四、在Vision 中创建专注周期10:37 五、 ... ... <看更多>