一點拙見-如何寫好一個技術預研報告?


最近做了一些預研的工作,主要是一些技術調研,報告呈現的過程當中收到了許多建設性的建議,同時包含一點自己的拙見,如果能給你帶來一些思考,那最好不過。
明確面向對象

一篇好的文章,一份好的報告一定要考慮一下的你面向對象,如何能夠讓他可以隨着你的思路快速簡要的理解你想要傳達的內容。那么,技術預研報告一般是給誰看的呢?請注意,我們這里說的報告是內部的調研報告,而不是例如一些專門做咨詢的公司,提供給外部公司購買使用。這種報告的面向對象一般而言是你的上級,或者是上上級,或者是更高層級的領導。

這個時候分為兩種情況,他懂技術,但是可能不了解細節,需要一些數據幫助他做決策,還有一種是他沒有太多的技術背景,不是特別了解。

如果是不太了解技術的領導,要注意不能用過多的專業術語,在報告里面可以適當的添加一些說明,類比輔助理解,這個篇幅需要注意,也不能過長。如果是比較了解的,可以更多的從技術方面進行分析,可以添加一些技術指標的對比。對於技術預研這種情況,一般還是這種情況居多。

接下來我就會從技術預研報告的一個最基礎的模板說明每個部分需要有哪些內容,這個不是標准答案,這是我認為的一個報告當中必要的一些元素。
預研報告模板
理清現狀

技術預研一般是用來解決當下我們需要解決的一些問題的,可能這些問題用已有的系統或者技術暫時無法解決,或者是解決方法不夠優雅,不夠簡潔等等。所以首先我們需要的是從現狀出發,理清需求找准目標。問題來了怎么描述現狀呢?我們先來看一個例子(注意本文所有示例數據均來源於虛構):
一個例子:

反面教材: 集群內應用的資源設置不合理正面教材: 最近一個月某區域集群節點 NotReady 告警次數超過 200 次,導致 30 多個應用 POD 漂移。其原因是由於應用超配比例過高,配置不合理
    數據說話: 最近一個月某區域集群節點 NotReady 告警次數超過 200 次影響范圍: 導致 30 多個應用 POD 漂移原因: 應用超配比例過高,配置不合理

上面這個示例是一個最常見的錯誤案例,在現狀分析當中,經常喜歡直接說問題的原因,不說這個問題導致的現象,以及影響范圍。我們需要明白查看我們調研報告的觀看對象是誰?往往是我們的上級或者是上上級領導,他們管理的產品比較多,不一定能夠理解到十分細節。所以我們要從場景觸發,首先降低溝通成本,羅列歷史數據,增強說服力的同時可以幫助他們了解當前產品的現狀。
如何說明現狀?

從實際的場景出發,簡明扼要的說明曾今出現過或者當前存在着的問題用數據說話,統計歷史數據,包含但不限於,影響范圍,出現的次數,反饋用戶人次等等

暢想未來

了解了現狀之后,我們需要有一個心理預期的結果,我們期望理想狀態下,能夠達到什么程度,這一部分可以腦洞大一些,期望高一點,不要局限在眼前。
一個例子

反面教材: 集群內應用隨意漂移,可以減少集群中節點故障次數正面教材: 為業務應用提供安全、可靠、穩定、舒心的服務,業務高峰時資源及時擴容,洪峰來臨時,優先確保核心應用穩定,力爭做到讓開發早下班,運維不加班,周末無告警,假期無負擔。

這兩個例子里面,反面教材太過於務實了,這個只能說是居於現狀的改進,不能說是對未來場景的想象,另一個是一個常見的場景加上一些形而上的想象。
如何暢享未來?

從場景出發,描繪理想狀態下可以達到的狀態結合現狀,切忌跑題,這是展望未來的時候,我最容易犯的一個錯誤,共勉。

行業實踐

站在巨人的肩膀上可以讓我們看的更遠,絕大部分的情況下調研時候的需求都會有一些業界的實踐案例,甚至有一些開源的社區方案,例如Google、亞馬遜、阿里、騰訊等,這是說他們的方案是否適合我們,能否落地。

對於行業的實踐這一塊的內容,建議采用表格的方式進行對比,如果可以的話還可以做一些現場演示,或者是錄制視頻。

如上表所示,就是一個十分常見的一個對比表格,這里需要注意的是,一定不要忘記我們當前的現狀是什么,最后可以有一個總結,說明不同方案的優劣之處,如果采用某個方案,后續是否需要更加深入的調研等等。
結論

調研一定要有結論!

這里結論不是決策,也不是一定是方案,由於時間、精力以及了解到的信息等等限制,可能導致我們當下是無法得出一個決策,是否采用某個方案,但是一定要有結論,這個結論,既可以是一個方向上的建議,也可以是需要繼續深入調研。切記不能僅為了調研而調研。
總結

或許由於我的視野原因,這篇文章會比較狹隘,但是如果你如果看了這篇文章能有一些思考,無論認同與否,那都很值得。

原文: https://lailin.xyz/post/how-to-write-a-pre-research-report.html


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM