基于obsidian进行技术文件归档的方法和应用

摘 要： 采用obsidian软件对技术文件进行归档，通过obsidian软件特有的双链功能，以及软件插件Dataview的使用，使归档文件中通用件/借用件能够链接到所有使用该通用件/借用件的产品上，并且以可视化的形式展现出来，协助通用件的设计更改以及通用件与借用件的升降级。
关键词： 技术文件归档；通用件/借用件；obsidian；双链；dataview

0 序言

2023年度，公司进一步加强了对技术文件归档的要求，研发部和工程技术中心都进行了大量的通用件归档。同时与技术质量部傅斌的日常工作沟通中了解到，为了进一步标准化管理，他希望将坑道门中借用件也单独拎出成为借用件库。随着时间的推移，通用件/借用件会不断增多。
《GJB 9001C-2017 质量管理体系要求》条款8.3.6要求“组织应对产品和服务在设计和开发期间以及后续所做的更改进行适当的识别、评审和控制，以确保这些更改对满足要求不会产生不利影响”。[1]在对通用件/借用件进行设计更改时，需要对到所有使用该通用件/借用件的产品进行评价，是否会对其产生不利影响。
借用件是指设计文件已归档的产品中被其他产品借用的零、部、整件，它形式上是专用件，实际上已成为通用件。借用件与通用件之间可以相互转化，经产品反复使用后，可优选出指标先进、 性能稳定、使用范围广的借用件，经过规定的评审、鉴定程序提 升为通用件。[2]
若无数据库专业人员，要实现上述需求，通常的做法是购买相关数据库软件对技术文件进行归档，但是会有相当的资金需求。所以，根据公司实情，研究一种操作简单、费用较少并满足以上需求的技术文件归档方法是很有必要的。

1  obsidain软件介绍

1.1  obsidian

Obsidian是一款基于本地MarkDown格式文件存储的免费编辑器软件，可以在无网络环境下操作，并且有丰富的插件资源进行功能拓展，被广泛应用于写作、笔记、个人日程管理。

1.2 双链

双链是Obsidian中的一项重要功能，它通过在md文件之间建立链接，使得用户可以在不同的md文件之间快速跳转和查找相关信息。

1.3 obsidian插件

1.3.1 Dataview

通过类似于SQL的语法，Dataview 插件可以对本地库中的md文件进行数据查询和筛选，并且创建和展示相应的动态视图。

1.3.2 Enhanced-editing

Enhanced-editing可将md文件中的字段快速转为双链格式。

1.3.3 quickadd（非必要）

QuickAdd可快速添加信息，捕捉想法，采用模板新建md文件和添加宏命令，快速执行多项操作。

1.3.4 button（非必要）

通过Buttons 插件可以把系统和插件内置的命令可视化展示，类似建立快捷方式一样，可以迅速执行设置好的命令。

2 研究目标

基于obsidian进行技术文件归档，预计达到以下目标：

1. 通过该方法，能够快速查询所有使用某一通用件/借用件的产品。
2. 通过该方法，能够快速查询所有通用件/借用件被借用次数。

3 工作原理

3.1 原理概述

根据归档文件创建obsidian软件的Dataview插件可读取的数据库。

3.2 实施难点

由于Obsidian是一个基于本地MarkDown格式文件存储的编辑器软件，若要实现上述目标，有下两个难点：

1. 将归档文件信息转化为md格式信息，创建查询数据库；
2. 编辑Dataview代码语句进行查询。

3.3 最终技术路线

通过对obsidian中文文档的研读，以及论坛教程，基于obsidian进行技术文件归档方法的技术路线如下：
a) 查询所有使用某一通用件/借用件的产品
1. 根据归档文件，对每一种产品建立md格式的清单（清单中文件名带后缀）；
2. 利用Enhanced-editing创建双链，将清单中的每一项与设计文件链接；
3. 编写Dataview代码语句，查询所有使用某一通用件/借用件的产品。
b) 查询通用件/借用件被借用次数
1. 根据归档文件，对每一种产品建立md格式的清单；（清单中文件名不带后缀）
2. 根据归档文件，通过echo命令，对所有通用件/借用件建立单独的md文件，并将其存储到单独的文件夹；
3. 根据归档文件，对每一个通用件/借用建立md格式的清单；
4. 编写Dataview代码语句，查询通用件/借用件被借用次数。

4 具体操作过程

4.1查询所有使用某一通用件/借用件的产品

1. 将产品设计文件移动到obsidian文件库中

2. 根据产品word格式零件清单转化为excel格式的零件清单。（excel格式的零件清单中的每一项与设计文件名称完全相同，需含文件后缀名）

3. 在obsidian中新建文件，将文件重命名为某一产品名称，将excel中的清单复制到该文件。

4. 使用Enhanced-editing创建双链。

5. 编辑Dataview查询语句进行查询。（此示例查询GPC通用件4被使用情况。）

4.2 查询通用件/借用件被借用次数

1）  将通用件/借用件文件夹移动到obsidian文件库中。

2）  在obsidian中查找该路径文件夹，并在查找结果中进行条件选择，并复制。

3）  根据复制内容，在excel中进行数据处理，创建每一个通用件/借用件的文件名

4）  创建.bat批处理文件（ANSI编码），批量创建以通用件/借用件文件名命名的md文件。

5）  将产品word格式零件清单转化为excel格式的零件清单，在obsidian中新建文件，将文件重命名为某一产品名称，将excel中的清单复制到该文件。（excel格式的零件清单中的每一项与设计文件名称完全相同，不含文件后缀名）

6）  编辑Dataview查询语句进行查询。

4.3 进一步操作改进方向

1）  使用excel编程，快速现实4.2.5、4.2.6项工作内容。
2）  使用QuickAdd、button插件快速实现4.1.5、4.2.7项工作内容。

5 结束语

将归档的技术文件信息转化MarkDown格式的信息，通过obsidian的双联功能将这些信息串联，运用简单的dataview代码语言，可简单、高效、直观、动态地展示通用件/借用件的使用情况，在设计更改、归档文件管理、产品标准化工作中能发挥极大作用。
参考文献
[1] 程旭辉. GJB 9001C-2017 质量管理体系要求[S].中央军委装备发展部:12.
[2] 朱敏.标准件、通用件、移用件的管理[J].信息技术与标准化.2012,10:49-52.