編寫一份友好的交互說明文檔要注意哪些
2021-8-17 ui設(shè)計(jì)分享達(dá)人
最近有設(shè)計(jì)小伙伴咨詢，怎么樣的交互說明才是最好的，是大家都喜歡的。最近他寫的交互說明文檔提交給需求評審會(huì)的成員審核時(shí)，大家都建議他再寫的合理些，這讓他傷透了腦筋。 第一、崗位對象不同：沒有一份十全十美的交互說明可以打動(dòng)所有人，讓所有人為之驚嘆。畢竟，由于閱讀交互說明文檔的對象不同，他們會(huì)對交互說明文檔有不同的要求，這是崗位屬性導(dǎo)致的結(jié)果。例如前端開發(fā)希望詳細(xì)到字段、初始默認(rèn)值、數(shù)據(jù)調(diào)取接口等，而領(lǐng)導(dǎo)只要看保證業(yè)務(wù)方向沒有錯(cuò)誤的大交互鏈路。 第二、同崗位不同認(rèn)知：同一崗位不同成員的認(rèn)知、從業(yè)經(jīng)歷、個(gè)人喜好、性格脾性等也會(huì)導(dǎo)致不可能有完美適配所有人的交互說明文檔。例如在一個(gè)行業(yè)已經(jīng)深耕多年的前端工程師，即使你的交互說明文檔寫的沒有那么詳細(xì)，他也可以從你現(xiàn)有的文字中推敲出其他方面，同時(shí)還能幫你補(bǔ)充完善；而針對剛?cè)胄械那岸斯こ處?，你要是寫的不詳?xì)，他就會(huì)抓狂，項(xiàng)目時(shí)間緊急的時(shí)候還會(huì)自己腦補(bǔ)交互細(xì)節(jié)。之后你走查時(shí)候也會(huì)抓狂，但是沒用呀，誰讓自己沒有寫明白交互細(xì)節(jié)，遺漏了呢。 第三、使用場合不同：不同場合需要的交互說明文檔也不同。例如與對方面對面溝通，交互說明文檔可以少寫點(diǎn)；但是通過線上工具與對方溝通，就需要寫的盡可能詳細(xì)；如果是會(huì)議型的評審，那就要方方面面都做足功課了。簡單來說就像準(zhǔn)備一份ppt：針對同一個(gè)主題的ppt，在外部演講和在公司內(nèi)部演講，同一份ppt會(huì)需要設(shè)計(jì)兩個(gè)版本，一個(gè)是內(nèi)部版，一個(gè)是外部版，原因在于使用場合不同。 第四、產(chǎn)品階段不同：交互說明文檔闡述的是一個(gè)產(chǎn)品的交互，而不是闡述其他的。如果產(chǎn)品所處階段為成熟期，那往往產(chǎn)品的交互文檔已經(jīng)沉淀了很多通用法則，可以被復(fù)用，那么現(xiàn)在的交互說明文檔少寫點(diǎn)，問題也不大；但產(chǎn)品處于探索期或成長期，通常來說可復(fù)用性的交互資產(chǎn)是不存在的，那交互說明文檔就需要準(zhǔn)備的相對完善。
有些設(shè)計(jì)小伙伴就說了，既然不可能滿足所有人，那我就按照自己的想法隨意寫好了。這可不行哦，畢竟我們的主要工作有一部分是撰寫交互說明文檔，這就必須要有認(rèn)真、嚴(yán)謹(jǐn)、專業(yè)的工作態(tài)度，把這部分工作做好。那我們來看看，編寫一份友好的交互說明文檔要注意哪些。
交互說明文檔是用來告訴參與產(chǎn)品研發(fā)的團(tuán)隊(duì)成員頁面交互相關(guān)細(xì)節(jié)的一個(gè)說明文檔，包括頁面間的邏輯跳轉(zhuǎn)、頁面內(nèi)模塊的交互、頁面功能的狀態(tài)等。交互說明文檔寫的越詳細(xì)越有利于參與產(chǎn)品研發(fā)各方的正確執(zhí)行。
我匯總了一些日常工作中有待改進(jìn)的交互說明文檔形式，看看都存在哪些問題。 幾乎所有剛初入職場的設(shè)計(jì)師，在編寫交互文檔時(shí)，會(huì)怕自己寫少了別人覺得自己不專業(yè)，怕寫的不全沒辦法表達(dá)頁面細(xì)節(jié)，導(dǎo)致交互文檔密密麻麻都是文字，這讓閱讀者幾乎無法閱讀，找不到視覺落腳點(diǎn)。
有幾年工作經(jīng)驗(yàn)的設(shè)計(jì)師，由于很多通用交互法則已了然于心，他們在編寫交互說明文檔時(shí)就比較簡單，一些交互就沒有寫在文檔上，這導(dǎo)致開發(fā)在開發(fā)時(shí)，忽略了某些交互。
交互稿數(shù)據(jù)沒有邏輯，是很多設(shè)計(jì)師經(jīng)常會(huì)出現(xiàn)的問題，一部分原因可能在于產(chǎn)品經(jīng)理沒有理順產(chǎn)品邏輯和細(xì)節(jié)就提交設(shè)計(jì)師畫圖了，另一部分原因可能在于設(shè)計(jì)時(shí)間緊張，來不及對交互稿中所有的數(shù)據(jù)都做到邏輯合理。 曾經(jīng)遇到過的情況有，關(guān)聯(lián)數(shù)值關(guān)聯(lián)不上，表格中字段對應(yīng)的值對不上，表單填寫的數(shù)據(jù)和實(shí)際情況不符。 建議大家在時(shí)間允許或有條件反推產(chǎn)品經(jīng)理協(xié)助完善數(shù)據(jù)的情況下，盡量數(shù)據(jù)展現(xiàn)的真實(shí)與符合邏輯，如此有助于開發(fā)及相關(guān)閱讀者高效理解。
有幾次我注意到設(shè)計(jì)師提交上來的交互說明會(huì)標(biāo)注“見圖X"這樣的文字。也就是一段說明讀完了，還得去頁面的某個(gè)角落尋找對應(yīng)的圖，這種體驗(yàn)非常不好。 在交互設(shè)計(jì)原則中有一項(xiàng)為“足不出戶”。“足不出戶”的意思是指能在當(dāng)前頁面解決的事情，不要去其他頁面；能在就近完成的事情，不要距離過遠(yuǎn)。頻繁的切換和跳轉(zhuǎn)會(huì)導(dǎo)致用戶心流被打斷，容易引起用戶思緒中斷、思考不劉暢，甚至可能對產(chǎn)品產(chǎn)生反感。 同理，我們交互說明文檔中的圖文也應(yīng)盡量相鄰，通過一眼文字一眼圖，讓用戶看的順暢、舒適，理解的快速。
東一句西一句是指交互說明文檔中本該成為一體去描述的文字，被分成了好幾個(gè)部分去闡述，這對看文檔的人來說簡直是災(zāi)難，他需要自己重新梳理交互思路，將交互規(guī)則串聯(lián)起來。
我們自己在編寫交互說明文檔時(shí)，盡量規(guī)避上述常見的問題。
對于什么是好的交互說明文檔，網(wǎng)上一搜一大把，這里我根據(jù)自己的經(jīng)驗(yàn)，和大家分享下什么是好的交互說明文檔。 首先我們來明確下，什么是好，有了好的標(biāo)準(zhǔn)以后，再來談?wù)勅绾巫龅胶谩?nbsp;通常情況下，交互文檔會(huì)給產(chǎn)品經(jīng)理看，用來評審設(shè)計(jì)方案是否滿足需求；給視覺設(shè)計(jì)師看，用來指導(dǎo)視覺方案的呈現(xiàn)；給前后端開發(fā)人員看，用來指導(dǎo)開發(fā)邏輯；給測試工程師看，用來協(xié)助測試編寫測試用例?；诖耍玫慕换フf明文檔關(guān)系著設(shè)計(jì)方案是否可被最大程度的實(shí)現(xiàn)。并且如果交互文檔文字冗長、邏輯不清晰，不僅看的人吃力，還會(huì)需要增加額外的時(shí)間來和開發(fā)工程師溝通。好的交互文檔，我認(rèn)為至少需要具備以下7點(diǎn)： 為了讓大家一邊學(xué)習(xí)一遍實(shí)踐，我使用“表單校驗(yàn)”的交互案例給大家進(jìn)行講解。 能協(xié)助項(xiàng)目成員通過文檔更順利地完成工作任務(wù)，能幫助用戶解決問題，能達(dá)成產(chǎn)品目標(biāo)，則是好的交互說明文檔。文檔對各方有價(jià)值，是一份好的交互說明文檔的起點(diǎn)。那么，如何編寫才能達(dá)到上述結(jié)果呢？ 一方面是將此次文檔的價(jià)值寫清楚，包括寫明此次交互設(shè)計(jì)的背景與需求來源、需求清單，標(biāo)明交互設(shè)計(jì)的理論依據(jù)，可以給用戶帶來的價(jià)值等。另一方面要和成員宣導(dǎo)這些內(nèi)容，讓成員感受自己要做的工作是有價(jià)值的。
拋開文檔閱讀對象等相關(guān)影響因素，通常來說交互需要考慮到以下幾方面: 整體交互流程是指產(chǎn)品頁面與頁面之間的交互邏輯。 頁面模塊交互說明是指模塊自身的交互說明，或同頁面內(nèi)獨(dú)立模塊之間的交互邏輯，或不同頁面模塊之間的交互邏輯。例如點(diǎn)擊導(dǎo)航樹節(jié)點(diǎn)會(huì)聯(lián)動(dòng)右側(cè)表格內(nèi)容刷新；點(diǎn)擊banner跳轉(zhuǎn)到對應(yīng)的商品詳情頁，且定位到頁面1/2位置。 頁面功能交互說明是指單個(gè)功能的各種情況闡述。例如搜索框內(nèi)輸入文字，通過enter觸發(fā)對應(yīng)頁面跳轉(zhuǎn)。 d、盡量真實(shí)的數(shù)據(jù)展示雖然是交互說明，我們也盡量做到模擬真實(shí)數(shù)據(jù)，否則很容易讓閱讀者產(chǎn)生錯(cuò)誤判斷。并不是所有人都會(huì)一字一句的去閱讀文檔，因此，盡量真實(shí)的數(shù)據(jù)，有利于閱讀者更有效的了解。 很多情況下，會(huì)因?yàn)槟承┰虺霈F(xiàn)極端交互情況，此時(shí)也需要補(bǔ)充完整。 建議交互團(tuán)隊(duì)為產(chǎn)品建立通用型交互說明庫，遇到類似的情況，直接調(diào)取即可。 實(shí)際上我們在編寫交互說明的時(shí)候，不太會(huì)分得那么細(xì)，很多說明是混合在一起表達(dá)的。 通俗易懂是指要讓文字、語言、圖片等做到讓受眾易于理解和感知，從而在信息傳遞過程中盡量少的出現(xiàn)損耗，這一點(diǎn)同時(shí)也與人類的理解能力有關(guān)。 “理解能力是指一個(gè)人對事物乃至對知識的理解的一種記憶能力。 低級水平的理解是指：知覺水平的理解，就是能辨認(rèn)和識別對象，并且能對對象命名，知道它“是什么”； 中級水平的理解是：在知覺水平理解的基礎(chǔ)上，對事物的本質(zhì)與內(nèi)在聯(lián)系的揭露，主要表現(xiàn)為能夠理解概念、原理和法則的內(nèi)涵，知道它是“怎么樣”； 高級水平的理解屬于間接理解，是指：在概念理解的基礎(chǔ)上，進(jìn)一步達(dá)到系統(tǒng)化和具體化，重新建立或者調(diào)整認(rèn)知結(jié)構(gòu)，達(dá)到知識的融會(huì)貫通，并使知識得到廣泛的遷移，知道它是“為什么”?！?nbsp;當(dāng)我們了解了人類的理解能力水平是參差不齊后，我們就要盡量在工作中將專業(yè)知識化繁為簡（也可以針對人群化繁為簡），增強(qiáng)溝通效果，最終達(dá)到完成團(tuán)隊(duì)目標(biāo)的結(jié)果。 交互文檔盡量做到講人話，不要講一堆專業(yè)術(shù)語。記得之前有個(gè)交互設(shè)計(jì)師在會(huì)議上闡述自己的交互方案時(shí)，提到用了“提供邀請”原則。由于與會(huì)成員是開發(fā)工程師和產(chǎn)品經(jīng)理，他們問到什么是“提供邀請”原則，并且在這個(gè)問題上大家討論了很久。
交互說明文檔除了要表達(dá)通俗易懂外，還需要結(jié)構(gòu)清晰。 結(jié)構(gòu)清晰的內(nèi)容不僅使閱讀者一目了然、理解成本低，還可以讓閱讀者了解撰寫者的意圖。要做到文檔結(jié)構(gòu)清晰，除了需要遵守一些規(guī)則外，也不能脫離當(dāng)前文檔的實(shí)際情況。 “表單校驗(yàn)”上場（把文字進(jìn)行分段處理，并取出關(guān)鍵詞）： 圖片和文字相得益彰可以加深閱讀者對文字的理解，同時(shí)避免閱讀者去想象文字對應(yīng)的結(jié)果。由于人們對同一段文字的理解不完全相同，因此建議設(shè)計(jì)師盡量安排交互說明對應(yīng)圖解。 僅此一份是說交付給團(tuán)隊(duì)交互說明文檔的時(shí)候不要多份。之前我們的前端小伙伴拿到了兩份交互文檔，一份是純原型交互文檔，一份是視覺稿交互文檔，兩者描述的信息大同小異。此時(shí)，建議交互文檔的信息做合并，只提交一份完整的給前端小伙伴，讓前端小伙伴能專心致志理解一份。
建議交互說明文檔留存修訂記錄，一方面可以了解交互文檔的變更歷史，另一方面有利于回溯和查找信息。修訂記錄一般包括修訂人、修訂時(shí)間和修訂內(nèi)容。
由于項(xiàng)目進(jìn)度、業(yè)務(wù)復(fù)雜程度等不同，我們不可能每次都能寫出一份最好的交互說明文檔，但我們可以想辦法寫出一份相對可讀性高、可理解性高的友好的交互說明文檔。我們常說自己是做用戶體驗(yàn)的，那交互說明文檔就是體現(xiàn)我們交互能力一個(gè)方面。 除了完成交互說明文檔，想要讓開發(fā)小伙伴真正理解交互說明，還需親自和開發(fā)溝通，千萬不要認(rèn)為我寫的很詳細(xì)了，他怎么還是實(shí)現(xiàn)的有偏差。事實(shí)上，就如開篇所說：同一崗位不同人的認(rèn)知理解、從業(yè)經(jīng)歷、個(gè)人喜好、性格脾性等也會(huì)導(dǎo)致理解不同。特別是對于一些我們非常創(chuàng)新的、特殊的交互點(diǎn)，需要重點(diǎn)和開發(fā)說明。 并且，交互說明文檔基于業(yè)務(wù)的發(fā)展，也會(huì)不斷的迭代，我們要抱著多聽、多想、多思考、多接受的態(tài)度去不斷優(yōu)化我們的文檔，盡力寫出一份友好的交互說明文檔。
藍(lán)藍(lán)設(shè)計(jì)建立了UI設(shè)計(jì)分享群，每天會(huì)分享國內(nèi)外的一些優(yōu)秀設(shè)計(jì)，如果有興趣的話，可以進(jìn)入一起成長學(xué)習(xí)，請掃碼ben_lanlan，報(bào)下信息，會(huì)請您入群。歡迎您加入噢~~希望得到建議咨詢、商務(wù)合作，也請與我們聯(lián)系。
文章來源：站酷 作者：知果日記
分享此文一切功德，皆悉回向給文章原作者及眾讀者.
免責(zé)聲明：藍(lán)藍(lán)設(shè)計(jì)尊重原作者，文章的版權(quán)歸原作者。如涉及版權(quán)問題，請及時(shí)與我們?nèi)〉寐?lián)系，我們立即更正或刪除。
藍(lán)藍(lán)設(shè)計(jì)( www.longkoushi.net )是一家專注而深入的界面設(shè)計(jì)公司，為期望卓越的國內(nèi)外企業(yè)提供卓越的UI界面設(shè)計(jì)、BS界面設(shè)計(jì) 、 cs界面設(shè)計(jì) 、 ipad界面設(shè)計(jì) 、 包裝設(shè)計(jì) 、 圖標(biāo)定制 、 用戶體驗(yàn) 、交互設(shè)計(jì)、 網(wǎng)站建設(shè) 、平面設(shè)計(jì)服務(wù)
