🧕🏿 🧑🏼‍🤝‍🧑🏻 👩🏿‍🏭 融合设计 🏼 🧙 👨🏼‍🎓

大家好！

我叫玛莎（Masha），我是Tinkoff公司集团的质量保证工程师。质量检查工作涉及与来自不同团队的不同人员进行大量交流，而且我还是教育计划的经理和讲师，因此我的交流图应尽可能广泛。在某个时候，我发生了爆炸：我意识到我再也无法，无法，无法填满成堆的无法读取的表和文档。

当然，每个人现在都想像我在说什么，然后冷汗流水：没有字母顺序的姓氏列表，布局已移出的数百列表格，成千上万行的表格，您需要在鼠标滚轮上擦除手指才能观看标题，成吨的非编号指令页面，数百个相互发送的数据字母，必须对其进行分析和系统化并将其填充到相同的不可读表中。

因此，当我有点感冒时，我决定写这篇文章。我将讨论如何正常（甚至有时很方便）维护各种非产品文档。我希望这篇文章会传播到整个网络，并且与开发相邻的部门的咨询程度甚至会略有下降，并且人们（包括我自己）会变得更加幸福。

工具类

产品文档通常与代码保持联系，这很好。非产品文档通常存储在任何地方。人们经常尝试将信息从不同的地方转移到Confluence，我们也不例外。所以关于他的整个故事。

通常，Confluence是高级Wiki引擎。它使您可以使用不同类型的显示中的数据：带格式的文本，表格，各种图表。这是一个非常有趣且功能强大的工具，但是如果您不知道如何烹饪它，则将得到另一个无法阅读的文档转储。我会教你如何做饭！

巨集

几乎所有Confluence魔术都是建立在宏上的。宏很多，它们可以相互组合。它们是收费的和免费的，然后将有不同的宏示例，并带有指向其文档的链接。

宏接口尽可能简单。要添加宏，请单击加号，然后从列表中选择所需的项目。

如果宏是自给自足的，也就是说，它不需要在自身内部插入其他内容，则它看起来像一个块。

如果要使宏起作用，则需要在其中放入一些东西，它看起来像一个框架。

同时，如果金字塔中只有逻辑，则可以在框架中放入任意数量的其他元素。

每个宏都有一个预览：它会立即显示您是否正确完成并配置了宏。

模式

除了宏之外，还有一个方便的工具来预填充内容-这是一个模板。
创建任何页面时都可以使用模板：只需单击“创建”按钮旁边的三个点，然后选择所需的模板。

然后，模板中的所有内容将被添加到创建的页面中。

任何人都可以从模板创建页面，但只有那些有权自行创建或编辑模板的页面。您可以向模板添加有关如何维护页面的其他说明。

餐桌魔术

实际上，作为一个技术人员，我非常喜欢表格，并且可以将几乎所有信息包装在表格中（尽管这并不总是有效的）。表格本身清晰，结构化，可扩展，神奇！

但是，即使像桌子这样美妙的实体也可能被破坏。而且您可以成功使用甚至改进。关于它下面。

过滤（付费插件）

通过过滤，可以使任何巨大的不可读表变得不那么庞大，并且可读性更高。为此，您可以使用付费宏“过滤器表”。

在此宏内，您需要粘贴表格（您甚至可以用最丑陋的方法，主要是将其整体压入）。在宏中，您可以选择带有下拉列表，文本过滤器，数字过滤器和日期过滤器的过滤器列。

试想一下，所有空缺候选人的所有信息都记录在表格列表中。自然地，没有分类-人们不会按字母顺序来采访。并且您需要了解您之前是否曾面试过特定的求职者。您只需要把这个地狱放到过滤器宏中，按姓氏添加文本过滤器-瞧，屏幕上的信息就可以了。

值得注意的是，过滤巨大的表可能会影响系统和页面加载时间，因此将巨大的表放入过滤器只是暂时的utch脚，因此最好构建一个无需创建大量无法读取的表的过程（该过程的示例将在本文结尾）。

排序（付费插件）

使用魔术宏“表格过滤器”，您还可以按任何列设置默认排序并为行编号。或单击弹出到过滤器宏的表的任何列，然后将按此列进行排序。

例如，您与申请人的表相同，并且需要弄清楚在特定月份进行了多少次面试-按日期排序并感到高兴。

摘要表（付费插件）

现在让我们继续进行更有趣的案例。想象一下，您的桌子很大，您需要从中计算出一些东西。当然，您可以将其复制到Excel，计算所需内容，然后将数据上传回Confluence。或者，您可以一次应用“数据透视表”宏，并获得相同的结果，但也可以对其进行更新。

例如：您有一个表，其中收集了所有员工的数据-他们在地理位置上的位置以及他们所处的位置。要计算每个城市有多少人，您需要在宏“摘要表”中选择一行，通过该行可以汇总数据（位置）和操作类型（汇总）。

自然，您可以一次按几个条件进行分组，所有功能都可以在文档中找到。

图表（付费插件）

正如我所说，并不是每个人都像我一样喜欢餐桌。不幸的是，他们大多数根本不喜欢经理。但是每个人都喜欢充满活力的颜色表。
当然，Confluence的创建者对此很了解（他们可能也有一个喜欢报告和图表的老板，但没有报告和图表）。因此，你可以使用魔法宏“从表中图表。” 在此宏中，您需要放置上一段中的数据透视表，然后瞧-您的灰色无聊数据可以清晰地显示出来。

当然，该宏也具有设置。在该宏的编辑模式下，可以找到任何宏的文档链接。

易于聚集

前几段中的信息可能对您来说不是一个启示。但是现在您肯定知道如何使用宏了，我可以继续进行本文更有趣的部分。

当人们将信息存储在一个非结构化的文章或一个巨大的表中时，这很糟糕。更糟的是，当这些信息的一部分不仅不可读，而且分散在汇流范围内时。幸运的是，有机会在一个地方收集分散的信息。为此，请使用标签（社交网络上每个人都熟悉的标签）。

您可以将任意数量的标签添加到任何页面。如果单击标签，您将被带到聚合页面，在该页面上有指向带有该标签以及一组相关标签的所有材料的链接。相关标签是经常在同一页面上找到的标签。

页面属性

您可以在页面中添加另一个有趣的宏以构建信息- “页面属性”。在其中，您需要提交一个包含两列的表，第一列将是键，第二列将是属性的值。此外，可以将宏从页面隐藏起来，以免干扰读取内容，但是与此同时，页面仍将标记有必要的键。

注意ID-将其设置为在不同页面上挂起不同的属性组（甚至在一页上悬挂不同的属性组）非常方便。

报告书

通过标签，您可以收集报告。例如，“内容报告”宏会收集带有一组特定标签的所有页面。

但是更有趣的报告是“页面属性报告”宏。它还会收集带有特定标签集的所有页面，但不仅会显示它们的列表，还会编译一个表（捕获到文章开头的链接？），其中的列是页面属性的键。

列出了来自各种来源的信息摘要表。很高兴它具有方便的功能：自适应布局，按任何列排序。同样，可以在宏内部配置这样的报告表。

配置时，您可以从报告中删除一些列，设置默认状态或显示的记录数。您还可以设置页面属性ID以仅查看所需的信息。

例如，您有很多员工页面，这些页面具有关于一个人的一组属性：他是什么级别，他在哪里，何时加入团队等等。这些属性用ID = employee_inf标记。并且在同一页面上还有第二组属性，这些属性收集有关人员的信息（作为团队的一部分）：人员扮演什么角色，他在哪个团队中等等。这些属性用ID = team_inf标记。然后，在组装报告时，您可以一次只显示一个或两个ID的信息，因为这样更方便。

这种方法的优点在于，每个人都可以收集所需的信息表，该信息表不会重复任何内容，并且会在更新主页时进行更新。例如：Timlidu在开发人员找到工作时并不重要，但重要的是他们每个人在团队中所扮演的角色。Timlid将收集有关该团队的报告。会计师并不关心谁扮演什么角色，但是帖子很重要-他会收集有关这些帖子的报告。在这种情况下，信息源将不会重复或转移。

最终程序

使用说明书

因此，我们可以使用宏作为示例，在Confluence中精美地构造和有效地聚合信息。但理想情况下，有必要确保立即构造新信息并将其纳入所有已使用的聚合机制中。

这里有大量的宏和模板可以帮助您。要使人们以正确的格式创建新页面，可以使用“从模板创建”宏。通过单击您需要的模板在其上创建新页面的方式，他在页面上添加了一个按钮。因此，您可以使人们立即以所需的格式工作。

在您要用来创建页面的模板中，您需要添加标签，“页面属性”宏和预先需要的属性表。我还建议添加有关应在页面中填充哪些值以及属性值的说明。

然后，最终过程将如下所示：

您为某种类型的信息创建模板。
将宏中的标签和页面属性添加到此模板。
在任何方便的地方，通过单击创建带有模板的子页面的按钮来创建根页面。
在可能会生成必要信息的用户的根页面上启动（根据所需模板，通过单击按钮）。
通过在模板中指定的标签收集有关页面属性的报告。
高兴：您以方便的格式获得了所有必要的信息。

水下岩石

作为质量工程师，我可以肯定地说，世界上没有理想。甚至神圣的餐桌也不完美。在上述过程中，存在陷阱。

如果决定更改页面属性的名称或组成，则必须更新所有已创建的对象，以便将其数据正确提取到摘要报告中。这很可悲，但是，另一方面，它使您详细考虑信息集的“体系结构”，这是一项非常有趣的任务。
您将不得不编写大量有关如何填写信息表和使用标签的说明。但是，另一方面，您可以在本文中抛出所有合适的人。

存储非产品文档的示例

通过上述过程，您可以组织几乎所有信息的存储。这种方法的优点在于它具有通用性：当用户习惯了这种方法后，他们便不再产生混乱。还有一个很大的优点（但不是免费的），它可以即时收集各种统计信息并在上面绘制漂亮的图表。

我将举例说明我们维护团队信息的过程。

我们决定为团队中的每个人创建一张员工卡。因此，我们有一个模板，根据这个模板，每个新人都可以自己创建该卡并在其中保留所有个人信息。

如您所见，我们有详细的属性表，并立即提供了有关如何维护此页面的说明。某些标签由员工自己按照说明放下，在模板中只有主要标签：卡标签员工卡，方向标签- 方向和团队质量标签。

结果，在每个人都为自己创建了卡之后，便获得了一张包含员工信息的完整表格。该信息可以在各个地方使用。资源管理器可以自己收集常规表，团队负责人可以通过在选择中添加团队标签来创建团队表。

您可以通过标签查看不同的摘要，例如，通过qa-upgrade-plan可以显示所有用于质量检查开发的任务。同时，员工卡中的每个人都会领导一个重要的故事和他的发展计划-从发展计划模板中创建一个嵌入式页面。

结论

保留任何文档，以免令人尴尬，并且不会对用户造成极大的伤害！

我真的希望这篇文章对您有所帮助，并且希望世界上所有的文档都井井有条。

融合设计

工具类

巨集

模式