大家好！
我叫 Masha，在 Tinkoff 集團公司擔任質量保證工程師。 QA 工作涉及與來自不同團隊的不同人員進行大量溝通，而且我還是教育項目的經理和講師，所以我的溝通地圖盡可能廣泛。 在某個時候我爆發了：我意識到我不能再，我不能，我不能填寫地獄般的大量不可讀的表格和文件。
想必你們每個人都想像出了我在說什麼，驚出了一身冷汗：沒有按字母順序排列的姓氏列表，數百列的表格，佈局草率，數千行的表格，你需要擦掉手指在鼠標滾輪上查看標題，大量未編號的說明頁面，數百封相互發送的信件，其中包含需要分析和系統化的數據，並塞入相同的不可讀表格中。
所以，當我冷靜下來時，我決定寫這篇文章。 我將討論如何正常（甚至有時方便地）維護各種非產品文檔。 我希望這篇文章能在網絡上傳播開來，希望與開發部門相鄰的部門的地獄級別至少下降一點，人們（包括我）會變得更快樂一點。
工具
產品文檔通常與代碼放在一起，這是一件好事。 非產品文檔通常存儲在任何地方。 通常人們會嘗試將來自不同地方的信息帶入 Confluence，我們也不例外。 所以剩下的故事都是關於他的。
總的來說，Confluence 是一個高級的 wiki 引擎。 它允許您在不同類型的顯示中處理數據：帶格式的文本、表格、各種圖表。 這是一個非常有趣且功能強大的工具，但如果您不知道如何使用它，那麼您將得到另一堆不可讀的文檔。 我來教你做飯！
宏
Confluence 的幾乎所有魔力都是圍繞宏構建的。 宏有很多，可以相互組合。 它們是付費的和免費的，此外還有各種宏示例以及它們的文檔鏈接。
使用宏的界面盡可能簡單。 要添加宏，您需要單擊加號並從列表中選擇所需的元素。
如果宏是自給自足的，也就是說，它不需要在自身內部插入其他東西，它看起來就像一個塊。
如果一個宏需要它內部的東西才能工作，它看起來像一個盒子。
同時，只要您的金字塔中有邏輯，您就可以在一個框架內放置任意多個其他框架。
每個宏都有一個預覽：它會立即顯示您是否已正確填寫和配置宏。
模板
除了宏之外，還有一個方便的預填充內容工具——這是一個模板。
創建任何頁面時都可以使用模板：只需單擊“創建”按鈕旁邊的三個點，然後選擇所需的模板。
然後模板中的所有內容都將添加到創建的頁面中。
任何人都可以從模板創建頁面，但只有有權自行創建或編輯模板的人才能創建頁面。 您可以向模板添加有關如何維護頁面的其他說明。
桌上魔術
實際上，作為一名技術人員，我非常喜歡表格並且可以將幾乎所有信息包含在表格中（儘管這並不總是有效）。 表格本身清晰、結構化、可擴展、神奇！
但即使是像桌子這樣美妙的實體也可能被破壞。 並且可以成功使用甚至改進。 更多關於下面的內容。
過濾（付費插件）
任何巨大的不可讀的表格都可以使用過濾變得不那麼龐大和可讀性更高。 為此，您可以使用付費宏 .
在這個宏中，您需要推一個表（即使是最醜陋的表也是可能的，最主要的是將它完全推）。 在宏中，您可以為下拉過濾器、文本過濾器、數字和日期過濾器選擇列。
試想一下，所有職位空缺的候選人的所有信息都記錄在一個表格列表中。 自然地，未分類——人們不會按字母順序來面試。 你需要了解你之前是否面試過特定的申請人。 你只需要把這個地獄放在一個過濾器宏中，按姓氏添加一個文本過濾器——瞧，信息就在你的屏幕上了。
值得注意的是，過濾巨大的表格會影響系統性能和頁面加載時間，所以將巨大的表格放在過濾器中是一個臨時的拐杖，最好建立一個人們不必創建巨大的不可讀表格的過程（一個該過程的示例將在文章的末尾）。
排序（付費插件）
用魔法宏 您還可以在任何列上設置默認排序並為行編號。 或者單擊放入過濾器宏的表格的任何列，將按該列排序。
例如，您與申請人有同一張表，您需要弄清楚某個月進行了多少次面試 - 按日期排序並高興。
數據透視表（付費插件）
現在讓我們繼續看一個更有趣的案例。 想像一下你的桌子很大，你需要在上面計算一些東西。 當然，您可以將其複製到 Excel，計算您需要的內容並將數據上傳回 Confluence。 你能應用一次宏嗎？ 並得到相同的結果，只是更新了。
例如：您有一個表，其中包含所有員工的數據——他們所處的地理位置以及所擔任的職位。 要計算每個城市有多少人，您需要在“數據透視表”宏中選擇聚合數據的行（位置）和操作類型（加法）。
當然，你可以同時根據幾個標准進行分組，你可以看到所有的可能性 .
圖表（付費插件）
正如我所說，並不是每個人都像我一樣喜歡桌子。 不幸的是，大多數經理根本不喜歡它們。 但是每個人都喜歡明亮的彩色圖表。
Confluence 的創建者當然知道這一點（當然他們也有喜歡報告和圖表的老闆，沒有它他們會在哪裡）。 因此，您可以使用魔術宏 . 在這個宏中，您需要放置上一段中的數據透視表，瞧 - 您無聊的灰色數據被精美地可視化了。
自然，這個宏也有設置。 可以在該宏的編輯模式中找到指向任何宏文檔的鏈接。
易於聚合
前面段落中的信息可能對您來說不是什麼啟示。 但現在您肯定知道如何使用宏，我可以繼續閱讀本文更有趣的部分。
標籤
當人們將信息存儲在一篇非結構化文章或一張巨大的表格中時，這很糟糕。 更糟糕的是，部分信息不僅不可讀，而且散佈在 Confluence 的各個角落。 幸運的是，可以將分散的信息集中在一個地方。 為此你需要使用 （社交網絡上每個人都熟悉的標籤）。
可以將任意數量的標籤添加到任何頁面。 單擊一個標籤會將您帶到一個聚合頁面，其中包含指向具有該標籤的所有內容以及一組相關標籤的鏈接。 相關標籤是那些經常出現在同一頁面上的標籤。
頁面屬性
您可以向頁面添加另一個有趣的宏以獲取結構化信息 - . 在其中，您需要提交一個包含兩列的表格，第一列是鍵，第二列是屬性的值。 此外，宏可以從頁面中隱藏起來，這樣它就不會干擾閱讀內容，但頁面仍會標有必要的鍵。
注意ID - 將其設置為將不同組的屬性掛在不同的頁面（甚至不同組的屬性在一個頁面上）很方便。
報告
通過標籤，您可以收集報告。 例如，宏 收集具有特定標籤集的所有頁面。
但是一個更有趣的報告是宏 . 它還收集了所有具有特定標籤集的頁面，但不只是列出它們，而是編制了一個表格（你抓住了與文章開頭的聯繫嗎？），其中的列是頁面屬性的鍵。
結果是來自不同來源的信息匯總表。 很高興它具有方便的功能：自適應佈局、按任何列排序。 此外，可以在宏內部配置這樣的報告表。
配置時，您可以從報告中刪除一些列，設置默認狀態或顯示的記錄數。 您還可以設置頁面屬性 ID 以僅查看您需要的信息。
比如你有很多員工頁面，這些頁面有一組關於一個人的屬性：他是什麼級別，他在哪裡，他什麼時候加入團隊等等。 這些屬性被標記 id = employee_inf. 同一頁面上還有第二組屬性，其中包含關於作為團隊一部分的人的信息：此人擔任什麼角色，他在哪個團隊中，等等。 這些屬性被標記 ID = team_inf. 然後，在編制報告時，您可以一次只顯示一個或兩個 ID 的信息 - 以更方便的為準。
這種方式的妙處在於，每個人都可以收集自己需要的信息表，不會重複任何內容，並且會在主頁更新時更新。 例如：團隊負責人不關心他的開發人員何時找到工作，但重要的是他們每個人在團隊中扮演什麼角色。 團隊負責人將收集團隊報告。 會計師不關心誰扮演什麼角色，但職位很重要——他會收集職位報告。 在這種情況下，不會復製或轉移信息來源。
最後工序
指令
因此，我們可以使用宏作為示例在 Confluence 中漂亮地構建和有效地聚合信息。 但理想情況下，您需要確保新信息立即結構化並進入所有已在使用的聚合機制。
這裡有一堆宏和模板可以派上用場。 要讓人們以正確的格式創建新頁面，您可以使用從模板創建宏。 它向頁面添加一個按鈕，通過單擊該按鈕從您需要的模板創建一個新頁面。 通過這種方式，您可以強制人們立即以您需要的格式工作。
在允許創建頁面的模板中，您需要添加標籤、“頁面屬性”宏和預先需要的屬性表。 我還建議添加有關用什麼值填充頁面和屬性值的說明。
那麼最後的流程會是這樣的：
- 您正在為特定類型的信息創建模板。
- 在此模板中，在宏中添加標籤和頁面屬性。
- 在任何方便的地方，創建一個帶有按鈕的根頁面，通過單擊從模板創建子頁面。
- 在可能會生成必要信息的用戶的根頁面上啟動（根據所需的模板，通過單擊按鈕）。
- 通過您在模板中指定的標籤為自己收集一份關於頁面屬性的報告。
- 慶幸：您以方便的格式獲得了所需的所有信息。
陷阱
作為質量工程師，我可以肯定地說世界上沒有完美的東西。 即使是神聖的桌子也不完美。 並且在上述過程中存在陷阱。
- 如果您決定更改頁面屬性的名稱或組成，則必須更新所有已創建的對象，以便將它們的數據正確地提取到摘要報告中。 這很可悲，但另一方面，它迫使您詳細考慮信息集的“架構”，這是一項非常有趣的任務。
- 您將不得不編寫大量關於如何填寫信息表和使用標籤的說明。 但是，另一方面，你可以把這篇文章扔給所有合適的人。
存儲非產品文檔的示例
通過上述過程，您可以組織存儲幾乎任何信息。 這種方法的美妙之處在於它是通用的：一旦用戶習慣了它，他們就不會再把事情弄得一團糟了。 還有一個很大的（但不是免費的）優點是能夠即時收集各種統計數據並在其上繪製漂亮的圖表。
我將舉例說明我們維護團隊信息的過程。
我們決定為團隊中的每個人創建一張員工卡。 因此，我們有一個模板，每個新人都可以根據這個模板為自己創建這張卡片，並將他的所有個人信息保存在裡面。
如您所見，我們有一個詳細的屬性表，並且立即有關於如何維護此頁面的說明。 有些標籤是員工根據說明自己放的，模板中只有主要的：卡片標籤 員工卡, 方向標籤 方向涉及 和命令標籤 團隊質量保證.
這樣一來，每個人都為自己創建了一張卡片後，就得到了一張完整的員工信息表。 此信息可用於不同的點。 資源經理可以為自己收集通用表，團隊負責人可以通過將團隊標籤添加到選擇中來收集命令表。
通過標籤，您可以看到不同的摘要，例如，通過 質量升級計劃 將顯示 QA 開發的所有任務。 同時，每個人的員工名片中都有一個重要的故事和自己的發展計劃——他根據發展計劃模板創建了一個嵌套頁面。
結論
以您不會為此感到羞恥並且用戶不會受到極度傷害的方式保存任何文檔！
我真的希望這篇文章有用，並且世界上所有的文檔都會有秩序。
來源： www.habr.com