您好！
我叫 Masha，在 Tinkoff 集团公司担任质量保证工程师。 QA 工作涉及与来自不同团队的不同人员进行大量沟通，我也是教育项目的经理和讲师，所以我的沟通地图尽可能广泛。 在某个时候我爆发了：我意识到我不能再，我不能，我不能填写地狱般的大量不可读的表格和文件。
想必你们每个人都想象出了我在说什么，惊出了一身冷汗：没有按字母顺序排列的姓氏列表，数百列的表格，布局草率，数千行的表格，你需要擦掉手指在鼠标滚轮上查看标题，大量未编号的说明页面，数百封相互发送的信件，其中包含需要分析和系统化的数据，并塞入相同的不可读表格中。
所以，当我冷静下来时，我决定写这篇文章。 我将讨论如何正常（甚至有时方便地）维护各种非产品文档。 我希望这篇文章能在网络上传播开来，希望与开发部门相邻的部门的地狱级别至少下降一点，人们（包括我）会变得更快乐一点。
工具
产品文档通常与代码放在一起，这是一件好事。 非产品文档通常存储在任何地方。 通常人们会尝试将来自不同地方的信息带入 Confluence，我们也不例外。 所以剩下的故事都是关于他的。
总的来说，Confluence 是一个高级的 wiki 引擎。 它允许您在不同类型的显示中处理数据：带格式的文本、表格、各种图表。 这是一个非常有趣且功能强大的工具，但如果您不知道如何使用它，那么您将得到另一堆不可读的文档。 我来教你做饭！
宏
Confluence 的几乎所有魔力都是围绕宏构建的。 宏有很多，可以相互组合。 它们是付费的和免费的，此外还有各种宏示例以及它们的文档链接。
使用宏的界面尽可能简单。 要添加宏，您需要单击加号并从列表中选择所需的元素。
如果宏是自给自足的，也就是说，它不需要在自身内部插入其他东西，它看起来就像一个块。
如果一个宏需要它内部的东西才能工作，它看起来像一个盒子。
同时，只要您的金字塔中有逻辑，您就可以在一个框架内放置任意多个其他框架。
每个宏都有一个预览：它会立即显示您是否已正确填写和配置宏。
模板
除了宏之外，还有一个方便的预填充内容工具——这是一个模板。
创建任何页面时都可以使用模板：只需单击“创建”按钮旁边的三个点，然后选择所需的模板。
然后模板中的所有内容都将添加到创建的页面中。
任何人都可以从模板创建页面，但只有有权自行创建或编辑模板的人才能创建页面。 您可以向模板添加有关如何维护页面的其他说明。
桌上魔术
实际上，作为一名技术人员，我非常喜欢表格并且可以将几乎所有信息包含在表格中（尽管这并不总是有效）。 表格本身清晰、结构化、可扩展、神奇！
但即使是像桌子这样美妙的实体也可能被破坏。 并且可以成功使用甚至改进。 更多关于下面的内容。
过滤（付费插件）
任何巨大的不可读的表格都可以使用过滤变得不那么庞大和可读性更高。 为此，您可以使用付费宏 .
在这个宏中，您需要推一个表（即使是最丑陋的表也是可能的，最主要的是将它完全推）。 在宏中，您可以为下拉过滤器、文本过滤器、数字和日期过滤器选择列。
试想一下，所有职位空缺的候选人的所有信息都记录在一个表格列表中。 自然地，未分类——人们不会按字母顺序来面试。 你需要了解你之前是否面试过特定的申请人。 你只需要把这个地狱放在一个过滤器宏中，按姓氏添加一个文本过滤器——瞧，信息就在你的屏幕上了。
值得注意的是，过滤巨大的表格会影响系统性能和页面加载时间，所以将巨大的表格放在过滤器中是一个临时的拐杖，最好建立一个人们不必创建巨大的不可读表格的过程（一个该过程的示例将在文章的末尾）。
排序（付费插件）
用魔法宏 您还可以在任何列上设置默认排序并为行编号。 或者单击放入过滤器宏的表格的任何列，将按该列排序。
例如，您与申请人有同一张表，您需要弄清楚某个月进行了多少次面试 - 按日期排序并高兴。
数据透视表（付费插件）
现在让我们转向一个更有趣的案例。 想象一下你的桌子很大，你需要在上面计算一些东西。 当然，您可以将其复制到 Excel，计算您需要的内容并将数据上传回 Confluence。 你能应用一次宏吗？ 并得到相同的结果，只是更新了。
例如：您有一个表，其中包含所有员工的数据——他们所处的地理位置以及所担任的职位。 要计算每个城市有多少人，您需要在“数据透视表”宏中选择聚合数据的行（位置）和操作类型（加法）。
当然，你可以同时根据几个标准进行分组，你可以看到所有的可能性 .
图表（付费插件）
正如我所说，并不是每个人都像我一样喜欢桌子。 不幸的是，大多数经理根本不喜欢它们。 但是每个人都喜欢明亮的彩色图表。
Confluence 的创建者当然知道这一点（当然他们也有喜欢报告和图表的老板，没有它他们会在哪里）。 因此，您可以使用魔术宏 . 在这个宏中，您需要放置上一段中的数据透视表，瞧 - 您无聊的灰色数据被精美地可视化了。
自然，这个宏也有设置。 可以在该宏的编辑模式中找到指向任何宏文档的链接。
易于聚合
前面段落中的信息可能对您来说不是什么启示。 但现在您肯定知道如何使用宏，我可以继续阅读本文更有趣的部分。
标签
当人们将信息存储在一篇非结构化文章或一张巨大的表格中时，这很糟糕。 更糟糕的是，部分信息不仅不可读，而且散布在 Confluence 的各个角落。 幸运的是，可以将分散的信息集中在一个地方。 为此你需要使用 （社交网络上每个人都熟悉的标签）。
可以将任意数量的标签添加到任何页面。 单击一个标签会将您带到一个聚合页面，其中包含指向具有该标签的所有内容以及一组相关标签的链接。 相关标签是那些经常出现在同一页面上的标签。
页面属性
您可以向页面添加另一个有趣的宏以获取结构化信息 - . 在其中，您需要提交一个包含两列的表格，第一列是键，第二列是属性的值。 此外，宏可以从页面中隐藏起来，这样它就不会干扰阅读内容，但页面仍会标有必要的键。
注意ID - 将其设置为将不同组的属性挂在不同的页面（甚至不同组的属性在一个页面上）很方便。
报告
通过标签，您可以收集报告。 例如，宏 收集具有特定标签集的所有页面。
但是一个更有趣的报告是宏 . 它还收集了所有具有特定标签集的页面，但不只是列出它们，而是编制了一个表格（你抓住了与文章开头的联系吗？），其中的列是页面属性的键。
结果是来自不同来源的信息汇总表。 很高兴它具有方便的功能：自适应布局、按任何列排序。 此外，可以在宏内部配置这样的报告表。
配置时，您可以从报告中删除一些列，设置默认状态或显示的记录数。 您还可以设置页面属性 ID 以仅查看您需要的信息。
比如你有很多员工页面，这些页面有一组关于一个人的属性：他是什么级别，他在哪里，他什么时候加入团队等等。 这些属性被标记 id = employee_inf. 同一页面上还有第二组属性，其中包含关于某个人作为团队成员的信息：此人扮演什么角色，他在哪个团队中，等等。 这些属性被标记 ID = team_inf. 然后，在编制报告时，您可以一次只显示一个或两个 ID 的信息 - 以更方便的为准。
这种方式的妙处在于，每个人都可以收集自己需要的信息表，不会重复任何内容，并且会在主页更新时更新。 例如：团队负责人不关心他的开发人员何时找到工作，但重要的是他们每个人在团队中扮演什么角色。 团队负责人将收集团队报告。 会计师不关心谁扮演什么角色，但职位很重要——他会收集职位报告。 在这种情况下，不会复制或转移信息来源。
最后工序
说明
因此，我们可以使用宏作为示例在 Confluence 中漂亮地构建和有效地聚合信息。 但理想情况下，您需要确保新信息立即结构化并进入所有已在使用的聚合机制。
这里有一堆宏和模板可以派上用场。 要让人们以正确的格式创建新页面，您可以使用从模板创建宏。 它向页面添加一个按钮，通过单击该按钮从您需要的模板创建一个新页面。 通过这种方式，您可以让人们立即以您需要的格式工作。
在允许创建页面的模板中，您需要添加标签、“页面属性”宏和预先需要的属性表。 我还建议添加有关用什么值填充页面和属性值的说明。
那么最后的流程会是这样的：
- 您正在为特定类型的信息创建模板。
- 在此模板中，在宏中添加标签和页面属性。
- 在任何方便的地方，创建一个带有按钮的根页面，通过单击从模板创建子页面。
- 在可能会生成必要信息的用户的根页面上启动（根据所需的模板，通过单击按钮）。
- 通过您在模板中指定的标签为自己收集一份关于页面属性的报告。
- 庆幸：您以方便的格式获得了所需的所有信息。
陷阱
作为质量工程师，我可以肯定地说世界上没有完美的东西。 即使是神圣的桌子也不完美。 并且在上述过程中存在陷阱。
- 如果您决定更改页面属性的名称或组成，则必须更新所有已创建的对象，以便将它们的数据正确地提取到摘要报告中。 这很可悲，但另一方面，它迫使您详细考虑信息集的“架构”，这是一项非常有趣的任务。
- 您将不得不编写大量关于如何填写信息表和使用标签的说明。 但是，另一方面，你可以把这篇文章扔给所有合适的人。
存储非产品文档的示例
通过上述过程，您可以组织存储几乎任何信息。 这种方法的美妙之处在于它是通用的：一旦用户习惯了它，他们就不会再把事情弄得一团糟了。 还有一个很大的（但不是免费的）优点是能够即时收集各种统计数据并在其上绘制漂亮的图表。
我将举例说明我们维护团队信息的过程。
我们决定为团队中的每个人创建一张员工卡。 因此，我们有一个模板，每个新人都可以根据这个模板为自己创建这张卡片，并将他的所有个人信息保存在里面。
如您所见，我们有一个详细的属性表，并且立即有关于如何维护此页面的说明。 有些标签是员工根据说明自己放的，模板中只有主要的：卡片标签 员工卡, 方向标签 方向涉及 和命令标签 团队质量保证.
这样一来，每个人都为自己创建了一张卡片后，就得到了一张完整的员工信息表。 此信息可用于不同的点。 资源经理可以为自己收集通用表，团队负责人可以通过将团队标签添加到选择中来收集命令表。
通过标签，您可以看到不同的摘要，例如，通过 质量升级计划 将显示 QA 开发的所有任务。 同时，每个人的员工名片中都有一个重要的故事和自己的发展计划——他根据发展计划模板创建了一个嵌套页面。
结论
以您不会为此感到羞耻并且用户不会受到极度伤害的方式保存任何文档！
我真的希望这篇文章有用，并且世界上所有的文档都会有秩序。
来源： habr.com