如何制訂乙個有效的內部規範

2021-08-15 09:27:49 字數 414 閱讀 7582

規範再好,落實不了,這不是瞎扯淡嗎?

乙個規範好不好內容固然非常重要,這裡我不講如何制訂乙個規範條例。

今天我們講的是如何表達描述你的規範。

制訂乙個規範,我最先關注的是規範誰?

知道了誰用,接下來就是要去用ta們的語言來描述這個規範,這或許就叫做接地氣。

我是搞研發的,文件是我的弱項,以前寫出來的文件規範,有些時候連自己看著文件都描述不清楚。

為什麼呢?

有些時候為了符合這個通用模板中某個章節或描述,又得硬生生的編出很多內容。

按照行內話說,通用往往是不好用。

如果你的規範不是對外,那麼我建議可以多接地氣點。

有些時候我寫些研發規範,更喜歡用些例子、**、流程圖來描述,因為搞研發的對這些東西都特別敏感,**有問題都能一眼看出來,更何況這邊只是要讓他們記住這些東西。

如何構建乙個有效的服務治理平台

本文我們重點討論如何構建乙個有效的服務治理平台,話不多說,直接切入整體。構建服務治理平台基於 管理 度量 管控 三個層面統籌考慮安排。具體來講,又可以分為六個層次來考慮問,分別是 服務管理流程體系,服務治理平台,服務治理核心架構,服務協議規範,服務支撐工具,服務執行環境。六個層面的具體關係如下圖所示...

如何寫乙個通用的README規範

我們平常在進行專案開發時,一般都會把 上傳至 託管平台上方便管理和維護。目前大家使用的託管平台最多的還是github,國內外還有一些比較知名的 託管平台,比如gitlab bitbucket,碼雲和碼市等。但我們在多人合作開發下,經常碰到的最頭疼的問題是,其他開發者在交接給我們乙個專案時只是對專案目...

如何在shell內部定義乙個函式

定義函式 函式名 呼叫函式 函式名傳參函式格式 傳引數 函式名 引數函式體呼叫引數 函式名 注意 類似於shell內建變數中的位置引數 簡單函式定義和呼叫示例 bin bash 函式使用場景一 執行頻繁的命令 dayin dayin函式傳參和函式體內呼叫引數示例 bin bash 函式的使用場景二 ...