產(chǎn)品文檔規(guī)范

注:
黑色為正常編輯
紅色修改編輯
灰色文檔已編寫圖未確定/待確定功能
按照時(shí)間順序排序 文檔廢棄
*紅色星號(hào)為必填項(xiàng)
文檔底色為黃色底色

一逞刷、范圍

本規(guī)范適用于本公司所有產(chǎn)品的排期众旗、文檔竭望、進(jìn)度、交互腌逢、需求會(huì)穿剖、驗(yàn)收的全部過程,產(chǎn)品部門必須嚴(yán)格遵守欧穴。

二民逼、產(chǎn)品排期

三、文檔

注:文檔更新需要及時(shí)的@相關(guān)人員

(1)涮帘、文檔主目錄

1.項(xiàng)目主目錄不允許出現(xiàn)多級(jí)同項(xiàng)目出現(xiàn)
2.層級(jí)清晰
3.說明準(zhǔn)確

示例:

潮星球 
  潮星球app
    潮星球v.1.0.0
      用戶登錄注冊(cè)
      驗(yàn)證碼登錄
    潮星球v.1.0.1
      用戶登錄注冊(cè)
      驗(yàn)證碼登錄
    潮星球v.1.0.2
  潮星球運(yùn)營后臺(tái)
    ....
  潮星球商家后臺(tái)
    ....
  潮星球官網(wǎng)
    ....

(2)拼苍、編寫目錄清晰


  • 版本號(hào):以小寫v開始,示例v.1.6.7 1為主版本號(hào) 6為子版本號(hào) 7為修正版本號(hào)
  1. 項(xiàng)目初版本時(shí)调缨,版本號(hào)可以為 0.1 或 0.1.0, 也可以為 1.0 或 1.0.0疮鲫,如果你為人很低調(diào),我想你會(huì)選擇那個(gè)主版本號(hào)為 0 的方式弦叶;
  2. 當(dāng)項(xiàng)目在進(jìn)行了局部修改或 bug 修正時(shí)俊犯,主版本號(hào)和子版本號(hào)都不變,修正版本號(hào)加 1伤哺;
  3. 當(dāng)項(xiàng)目在原有的基礎(chǔ)上增加了部分功能時(shí)燕侠,主版本號(hào)不變者祖,子版本號(hào)加 1,修正版本號(hào)復(fù)位為 0绢彤,因而可以被忽略掉七问;
  4. 當(dāng)項(xiàng)目在進(jìn)行了重大修改或局部修正累積較多,而導(dǎo)致項(xiàng)目整體發(fā)生全局變化時(shí)茫舶,主版本號(hào)加 1械巡;
  5. 另外,編譯版本號(hào)一般是編譯器在編譯過程中自動(dòng)生成的饶氏,我們只定義其格式讥耗,并不進(jìn)行人為控制。
  • 編寫人:自身名字全稱編寫
  1. 創(chuàng)建人是本人時(shí)直接編寫后續(xù)文檔
  2. 修改文檔人發(fā)生變更時(shí)疹启,需在下方添加編寫人
  3. 不許使用別名
  • 類型:針對(duì)于文檔面向的應(yīng)用端(app/web)
  1. 注明針對(duì)的具體端名稱(以英文簡寫為準(zhǔn))
  2. 當(dāng)出現(xiàn)app端與web端的功能交互時(shí)亏栈,分兩個(gè)表格編寫
  • 主要變更內(nèi)容:主要概述文檔的修改內(nèi)容
  1. 不允許出現(xiàn)表述不清蛾找,要做到見名知意
  2. 第一個(gè)創(chuàng)建內(nèi)容藍(lán)色標(biāo)注筷登,之后的修改黑色字
  • 時(shí)間:更新創(chuàng)建文檔的時(shí)間
  1. 時(shí)間不許寫2022.02.09蝌数,寫為2022.2.9
  2. 更新時(shí)間需要及時(shí)更新

1.模塊目錄

功能:模塊的文檔整理在開發(fā)完成之后把確認(rèn)的文檔放入模塊中菲宴。
目的:方便贷祈、快捷的了解每個(gè)每個(gè)產(chǎn)品功能的時(shí)間、開發(fā)版本喝峦、文檔編寫人員势誊、變更內(nèi)容。
示例:

微信截圖_20220209133842.png

2.周開發(fā)目錄

功能:在每周召開需求會(huì)之前必須編寫完成文檔的開發(fā)目錄谣蠢。
目的:方便粟耻、快捷的了解每個(gè)產(chǎn)品功能時(shí)間、開發(fā)版本眉踱、文檔編寫人員挤忙、變更內(nèi)容。
示例:


image.png

(3)文檔內(nèi)容


    1. 文檔編寫放在最左側(cè)谈喳,功能延續(xù)時(shí)册烈,需要換行
    1. 功能單一性,保證一行只存在一個(gè)功能屬性
    1. 展示頁面需要把展示的所有屬性列舉(顯示&顯示規(guī)則)
    1. 排序每一個(gè)的排序前綴標(biāo)明明確婿禽,用箭頭劃分優(yōu)先級(jí)
    1. 報(bào)錯(cuò)給的錯(cuò)誤碼赏僧,標(biāo)注明確
    1. 交互邏輯當(dāng)出現(xiàn)標(biāo)記時(shí)標(biāo)注明確,當(dāng)出現(xiàn)需要1,2,3,4.....說明時(shí)扭倾,嚴(yán)格遵循編號(hào)標(biāo)記
    1. 原型圖放在右側(cè)淀零,當(dāng)出現(xiàn)標(biāo)識(shí)時(shí),注明標(biāo)識(shí)定義

示例:

#顯示&顯示規(guī)則
返回按鈕膛壹;
頁面標(biāo)題:教育經(jīng)歷驾中;
提交審核唉堪;
#包含元素:
   *所在地(通過三級(jí)聯(lián)動(dòng)選擇省、市)
   *院校名稱(長度20個(gè)字哀卫,只能輸入中文英文巨坊,不允許輸入特殊字符)
   *專業(yè)信息(長度20個(gè)字,只能輸入中文英文此改,不允許輸入特殊字符)
   *入學(xué)年份(彈出時(shí)間窗口趾撵,選擇時(shí)間)    【2022.2.10修改 ws】
   *畢業(yè)年份(彈出時(shí)間窗口,選擇時(shí)間共啃,不可早于入學(xué)年份) 【2022.2.11 新增 rjq】
   *學(xué)位(學(xué)士占调、碩士、博士)
   *認(rèn)證材料(提交圖片格式 png/jpeg)

#排序規(guī)則&分頁
動(dòng)態(tài)排序:按照活躍度倒序——>創(chuàng)建人名稱正序——>創(chuàng)建時(shí)間倒序   【2022.2.10修改 ws】
動(dòng)態(tài)排序:按照活躍度倒序——>創(chuàng)建人名稱倒序——>創(chuàng)建時(shí)間倒序    【2022.2.11 修改 rjq】
社團(tuán)排序:按照發(fā)布時(shí)間倒序
分頁一頁展示15條數(shù)據(jù)

#報(bào)錯(cuò)文案
院校名稱格式錯(cuò)誤   院校名稱格式錯(cuò)誤
輸入信息不完整       輸入信息不完整

#交互邏輯
點(diǎn)擊返回按鈕移剪,跳轉(zhuǎn)至我的-簡介
點(diǎn)擊提交審核按鈕究珊,跳轉(zhuǎn)至提交成功頁
①修改提示 修改成功
  1.  修改錯(cuò)誤停留在本頁面
  2.  修改正確返回
②刪除提示  刪除成功
③返回按鈕  返回個(gè)人主頁

示例:


Image.png

(4)流程圖/xd圖

  1. 流程架構(gòu)圖,邏輯清晰纵苛,說明準(zhǔn)確
  2. 形成閉環(huán)
    示例:


    20220127-155416.png

四剿涮、進(jìn)度

  1. 嚴(yán)格控制產(chǎn)品編輯開發(fā)文檔的時(shí)間進(jìn)度
  2. 按時(shí)的把原型圖給到ui設(shè)計(jì)


    微信截圖_20220209133842.png

五、需求評(píng)審/需求會(huì)

(1)攻人、需求評(píng)審

1取试、每周四進(jìn)行下一周開發(fā)需求的需求評(píng)審會(huì)議。
2怀吻、會(huì)議發(fā)起人:產(chǎn)品經(jīng)理
3瞬浓、會(huì)議參與人:需求相關(guān)負(fù)責(zé)人、項(xiàng)目負(fù)責(zé)人蓬坡、開發(fā)小組負(fù)責(zé)人猿棉。
4、會(huì)議內(nèi)容:對(duì)照產(chǎn)品需求文檔屑咳,講解需求內(nèi)容萨赁。會(huì)議參與人對(duì)需求做出合理性評(píng)估,開發(fā)可實(shí)現(xiàn)性評(píng)估兆龙。
5位迂、會(huì)后:會(huì)議后產(chǎn)品經(jīng)理對(duì)問題進(jìn)行記錄,修改详瑞,完善掂林。

(2)需求會(huì)

1、周一進(jìn)行開發(fā)需求的需求會(huì)坝橡。
2泻帮、會(huì)議發(fā)起人:產(chǎn)品經(jīng)理。
3计寇、會(huì)議參與人:參與本次需求開發(fā)的前端開發(fā)锣杂,后端開發(fā)脂倦,web開發(fā),以及測(cè)試人員元莫。
4赖阻、會(huì)議線上進(jìn)行:將本次需要開發(fā)的需求完整的向開發(fā)和測(cè)試展示需求文檔,原型圖踱蠢,以及講述詳細(xì)需求內(nèi)容火欧。
5、開會(huì)之前必須@到相關(guān)人員茎截,確保全部人員進(jìn)入會(huì)議苇侵。

(3)、驗(yàn)收

1企锌、產(chǎn)品經(jīng)理驗(yàn)收榆浓,在開發(fā)將本次功能提測(cè)時(shí),產(chǎn)品經(jīng)理同時(shí)去驗(yàn)收本次功能點(diǎn)的開發(fā)完成度撕攒,以及正確性陡鹃。
2、發(fā)包之前抖坪,項(xiàng)目負(fù)責(zé)人對(duì)本次功能進(jìn)行查驗(yàn)杉适。
3、需要Android和ios端全部進(jìn)行驗(yàn)收柳击。
4、驗(yàn)收通過則進(jìn)行發(fā)包片习,驗(yàn)收不通過則不允許發(fā)包捌肴。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市藕咏,隨后出現(xiàn)的幾起案子状知,更是在濱河造成了極大的恐慌,老刑警劉巖孽查,帶你破解...
    沈念sama閱讀 221,820評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件饥悴,死亡現(xiàn)場離奇詭異,居然都是意外死亡盲再,警方通過查閱死者的電腦和手機(jī)西设,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,648評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來答朋,“玉大人贷揽,你說我怎么就攤上這事∶瓮耄” “怎么了禽绪?”我有些...
    開封第一講書人閱讀 168,324評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵蓖救,是天一觀的道長。 經(jīng)常有香客問我印屁,道長循捺,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,714評(píng)論 1 297
  • 正文 為了忘掉前任雄人,我火速辦了婚禮从橘,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘柠衍。我一直安慰自己洋满,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,724評(píng)論 6 397
  • 文/花漫 我一把揭開白布珍坊。 她就那樣靜靜地躺著牺勾,像睡著了一般。 火紅的嫁衣襯著肌膚如雪阵漏。 梳的紋絲不亂的頭發(fā)上驻民,一...
    開封第一講書人閱讀 52,328評(píng)論 1 310
  • 那天,我揣著相機(jī)與錄音履怯,去河邊找鬼回还。 笑死,一個(gè)胖子當(dāng)著我的面吹牛叹洲,可吹牛的內(nèi)容都是我干的柠硕。 我是一名探鬼主播,決...
    沈念sama閱讀 40,897評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼运提,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼蝗柔!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起民泵,我...
    開封第一講書人閱讀 39,804評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤癣丧,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后栈妆,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體胁编,經(jīng)...
    沈念sama閱讀 46,345評(píng)論 1 318
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,431評(píng)論 3 340
  • 正文 我和宋清朗相戀三年鳞尔,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了嬉橙。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,561評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡寥假,死狀恐怖憎夷,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情昧旨,我是刑警寧澤拾给,帶...
    沈念sama閱讀 36,238評(píng)論 5 350
  • 正文 年R本政府宣布祥得,位于F島的核電站,受9級(jí)特大地震影響蒋得,放射性物質(zhì)發(fā)生泄漏级及。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,928評(píng)論 3 334
  • 文/蒙蒙 一额衙、第九天 我趴在偏房一處隱蔽的房頂上張望饮焦。 院中可真熱鬧,春花似錦窍侧、人聲如沸县踢。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,417評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽硼啤。三九已至,卻和暖如春斧账,著一層夾襖步出監(jiān)牢的瞬間谴返,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,528評(píng)論 1 272
  • 我被黑心中介騙來泰國打工咧织, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留嗓袱,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,983評(píng)論 3 376
  • 正文 我出身青樓习绢,卻偏偏與公主長得像渠抹,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子闪萄,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,573評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容