文檔的管理是為了使工作內(nèi)容減少彤蔽,降低溝通成本让禀,所以無論好壞挑社,能夠達(dá)到目的的文檔就是好文檔,對于大公司而言可能文檔顧忌的內(nèi)容居多堆缘,小公司需要發(fā)揮其優(yōu)勢就是簡潔滔灶、便于理解,甚至有時(shí)候文檔不是必須的吼肥,只要能夠更高效率的直接溝通录平,時(shí)刻跟進(jìn)進(jìn)度,產(chǎn)品制作出來自然就沒有問題缀皱,但一般來說要么就是工程師不斷找產(chǎn)品經(jīng)理重復(fù)確認(rèn)斗这,導(dǎo)致效率下降。所以對于重要的細(xì)節(jié)邏輯最好用文檔描述記錄下來啤斗,給予工程師開發(fā)指導(dǎo)表箭。
對于不同文檔的格式每個(gè)公司、每個(gè)人使用的都不一樣钮莲,也沒有通版免钻,我們只要滿足以下幾個(gè)條件即可:
1.邏輯清晰
自己一定要先理解你想說的,并且描述的明白崔拥,如果不明白就開會一起討論并且對于達(dá)成一致性的內(nèi)容要最后確認(rèn)极舔,對于一些不同的觀點(diǎn)要講清楚取舍的原則,圍繞原則才能堅(jiān)定內(nèi)心的開發(fā)链瓦,減少溝通的幾率拆魏。
? ? (1)功能框架邏輯
????功能日益復(fù)雜的情況下,就會用到框架慈俯,框架有利于產(chǎn)品思路的梳理渤刃,未來產(chǎn)品的規(guī)劃引導(dǎo),也就是缺什么補(bǔ)什么贴膘,對于研發(fā)來說結(jié)構(gòu)可以讓他們各自分工卖子,把代碼之間的耦合性降低,以便于后期開發(fā)刑峡。
? ? ????拆分法
? ? ? ? 零散枚舉→歸類→補(bǔ)充
? ? (2)業(yè)務(wù)流程邏輯
? ? ? ? 指的是功能使用流程步驟揪胃,一個(gè)是面向?qū)ο罅в础⒁粋€(gè)是面向事件
? ?? ? 1. 面向事件
? ? ? ? 指的是完成一件事情需要多次操作,所有的步驟流程喊递。
? ? ? ? 2.面向?qū)ο?/b>
? ? ? ? 指的是對象的生命周期代表著一次完整的功能使用随闪,對象帶著數(shù)據(jù),經(jīng)過各種方法轉(zhuǎn)化流程直至達(dá)到目標(biāo)為止骚勘。
? ? 3.功能描述邏輯
? ? ? ? 功能描述最怕就是疏漏铐伴,有沒有考慮到的情況,所以一定要有結(jié)構(gòu)性的梳理俏讹,完整的枚舉当宴,枚舉的越詳細(xì)越好。
????????先橫向枚舉泽疆、再縱向深入户矢。
? ? 1.完整性
? ? ? 不僅要考慮到正常情況的完整殉疼,還要考慮到特殊情況梯浪,避免程序上的bug和功能上的錯(cuò)誤。
? ? 2.條件判斷清晰
? ? ?有明確的依據(jù)標(biāo)準(zhǔn)瓢娜,什么情況下啟用什么功能挂洛,進(jìn)行哪一類判斷,不然程序中的判斷方法和代碼就會混亂以至于出現(xiàn)bug眠砾。
? ? 3.含義明確
? ? ? 盡量避免名詞縮寫帶來的解釋混淆虏劲,使用新詞時(shí)一定要備好案,通知好褒颈、溝通好柒巫。
? ? ?4.敘述背景
? ? ? ? 和團(tuán)隊(duì)講述功能設(shè)計(jì)的同事最好闡述你的思路,你的靈感來源谷丸,讓他們更能理解你的想法堡掏,從而減少程序開發(fā)的誤差。
2.沒有疏漏
剛開始接受一個(gè)團(tuán)隊(duì)淤井,對于每個(gè)人的工作方式都不了解布疼,每個(gè)人的需求點(diǎn)不了解摊趾,導(dǎo)致疏漏總是會有币狠,這時(shí)候我們要不斷補(bǔ)充完善文檔,將每個(gè)人的需求點(diǎn)都滿足在內(nèi)砾层,創(chuàng)造出最適合自己團(tuán)隊(duì)的文檔漩绵。
3.可讀性強(qiáng)
把將會讀這篇文檔的人的知識范圍了解清楚,比如設(shè)計(jì)師要的是rgb肛炮,你說的是顏色名詞止吐,這樣他會很疑惑宝踪,但是對于其他人可能只需要知道或只懂顏色名詞。盡量了解相關(guān)協(xié)調(diào)人員的工作流程碍扔,知道了他們工作流程中的需要瘩燥、可能遇到的的問題,預(yù)先給予解決方案不同,這樣才能讓他們的工作更加順暢厉膀。