如何记录无所不在的语言?


14

我们公司正在将大量手动业务流程(以及相关的机构知识)转换为新的企业软件。该项目的进展非常顺利,但是随着我们的进行,很明显,业务和开发方面的术语和定义存在很多混乱。

我已经知道Evan关于形成一种普遍存在的语言的争论已有一段时间了,但这是我第一次需要正式记录它们。当我环顾四周并尝试思考在哪里/如何记录我们的UL条款时,我有点迷失了。

其他公司如何记录无所不在的语言?这只是一个Wiki风格的词典吗?是否有用于此目的的工具?


1
这是一个不错的开始:thepaulrayner.com/blog/2013/05/07/…。我特别喜欢这段话:“重要的不是应该记录域,而是要理解域,并且与开发软件的每个人都应共享这种理解。”
罗伯特·哈维

哇-这个问题真棒。如果有这个问题,我将调查EventStorming,看看是否有一种明智的方式来记录该过程的结果。
VoiceOfUnreason 2015年

Answers:


4

您可以将“无处不在的语言文档”视为软件定制项目:您需要使用一些软件来进行文档管理,并使其适应您的特定需求。在软件项目中,通常从收集用户需求开始,然后构建信息体系结构和设计解决方案,然后继续实施。以下是此过程的示例。

用户对此有何需求?在一些组织中,具有来自不同领域的不同功能的人们希望使用通用语言来描述他们的问题和解决方案。由于语音在这里可能并不重要,语法将基于该语言的文学形式,因此该方言将仅由其词汇(单词和辞典)来定义。要记录方言,您需要设计一个最适合管理词汇表(术语表)的文档结构。

人们可能希望使用此文档来学习单词或首字母缩写的含义,通过其同义词或定义来查找正确的单词,或者学习组成该域的所有单词。

对于这些用户需求,Wiki确实是一个不错的选择。它如何适合?在Confluence或MediaWiki之类的良好Wiki系统中,可以:

  • 为每个术语创建一篇文章。
  • 在某些模板中定义文章的公共结构,以便它们将包含一些可用于聚合的公共部分。
  • 在其他Wiki文章中轻松添加术语定义的链接。
  • 使用术语定义构建汇总表,并将其嵌入其他文档中。

目前,我正在使用Confluence来记录信息体系结构,并且无处不在的语言定义是其中的一部分。本文档的最高级别是领域文章。在每个应用程序中,都有多个域,例如安全性,支付等。这些域是由用户与系统的多次交互定义的,可以通过通用语言来描述,因此我将这些交互的定义放在单独的子页面和定义中这些交互在交互页面的子页面中引入的术语。我将汇总表放在父页面上,因此可以看到例如哪些场景组成了域以及定义了哪些术语。

完成此文档结构并转到更详细的系统规格后,我可以简单地参考场景的IA和UL定义,例如“组件A通过传递有关以下内容的信息来实现与系统B的集成,以支持交互C(IA场景链接)。 Z(UL链接)”。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.