基于Git与Python的档案制度建设贯彻自动化实操指南

一、环境准备与基础工具安装

在开始构建档案制度体系之前，必须先准备好运行环境。本方案基于Git进行版本控制，利用Python编写自动化检测脚本。请确保你的操作系统已安装以下基础工具。

1. 安装Git版本控制系统

Git是档案版本管理的核心。对于Windows用户，下载并安装Git for Windows，安装过程中务必选择“Git Bash Here”集成选项。对于Linux或macOS用户，直接使用包管理器安装。

Windows安装命令（使用Chocolatey或Scoop）：

choco install git

Linux/macOS安装命令：

sudo apt-get install git
brew install git

安装完成后，必须在终端配置全局用户信息，这是档案追溯责任人的关键步骤。

git config --global user.name "档案管理员"
git config --global user.email "admin@company.com"

2. 安装Python运行环境

本指南的自动化检测脚本依赖Python 3.8及以上版本。请前往Python官网下载对应系统的安装包。安装时，务必勾选“Add Python to PATH”选项。

验证安装是否成功，在终端执行：

python --version

二、构建标准化档案目录结构

档案制度建设的首要环节是物理结构的标准化。混乱的文件夹结构会导致检索效率低下。我们需要建立一个严格的树状目录，并利用Git进行初始化。

请在你的工作盘中创建一个名为“DigitalArchives”的根目录，并执行以下命令建立标准子目录：

mkdir DigitalArchives
cd DigitalArchives
mkdir -p {01_行政制度,02_技术文档,03_审计记录}/{draft,review,published}

上述命令将创建一个三级目录结构：一级为业务分类，二级为文件状态（草稿、审核、已发布）。这种结构强制要求文件归档时必须明确状态，杜绝随意存放。

初始化Git仓库：

git init

三、定义档案命名与元数据规范

为了贯彻档案制度，必须制定硬性的文件命名规则。本系统规定以下规则，任何不符合规则的文件都将被系统拦截，禁止归档。

1. 文件命名规范

• 格式： [部门代码]-[日期]-[文档类型]-[序号].md
• 示例： TECH-20231027-ARCHIVE-001.md
• 说明： 文件必须采用Markdown格式，便于版本对比和全文检索。

2. 文件元数据规范

每个档案文件的头部必须包含标准的YAML元数据块，用于记录文档的作者、密级、版本号等关键信息。

标准头部模板：

author: 张三
department: 技术部
date: 2023-10-27
version: v1.0
classification: secret

四、开发自动化合规检测脚本

这是贯彻档案制度的核心技术手段。我们将编写一个Python脚本，挂载到Git的提交钩子上。该脚本会在每次提交前自动扫描所有待提交的文件，一旦发现命名错误或元数据缺失，立即终止提交并报错。

在项目根目录下创建文件 pre_commit_check.py，并写入以下完整代码：

import os
import re
import sys
import subprocess
定义正则规则匹配标准命名：部门代码(2-4位大写)-日期(8位)-类型(大写)-序号(3位).md
FILENAME_PATTERN = re.compile(r'^[A-Z]{2,4}-\d{8}-[A-Z]+-\d{3}\.md$')
定义必须包含的元数据字段
REQUIRED_METADATA = ['author', 'department', 'date', 'version', 'classification']
def check_filename(filename):
"""检查文件名是否符合命名规范"""
if not FILENAME_PATTERN.match(filename):
print(f"\033[91m[错误] 文件名不符合规范: {filename}\033[0m")
print("正确格式示例: TECH-20231027-ARCHIVE-001.md")
return False
return True
def check_metadata(filepath):
"""检查文件头部是否包含完整的元数据"""
try:
with open(filepath, 'r', encoding='utf-8') as f:
content = f.read(500)  只读取前500字符以检测头部
except Exception as e:
print(f"\033[91m[错误] 无法读取文件: {filepath}\033[0m")
return False
if not content.startswith(''):
print(f"\033[91m[错误] {filepath} 缺少YAML元数据头部 (必须以开头)\033[0m")
return False
提取元数据部分
try:
end_meta = content.index('', 3)
meta_content = content[3:end_meta]
except ValueError:
print(f"\033[91m[错误] {filepath} 元数据头部未正确闭合 (必须以结束)\033[0m")
return False
检查必填字段
missing_fields = []
for field in REQUIRED_METADATA:
if field + ':' not in meta_content:
missing_fields.append(field)
if missing_fields:
print(f"\033[91m[错误] {filepath} 缺少必填元数据字段: {', '.join(missing_fields)}\033[0m")
return False
return True
def main():
获取Git暂存区中的文件列表
try:
获取所有被添加到暂存区的文件
result = subprocess.run(['git', 'diff', '--cached', '--name-only', '--diff-filter=ACM'],
capture_output=True, text=True)
staged_files = result.stdout.splitlines()
except Exception as e:
print("无法执行git命令，请确保在Git仓库中运行。")
sys.exit(1)
if not staged_files:
print("没有文件待提交，检查通过。")
sys.exit(0)
print("开始执行档案制度合规性检查...")
all_passed = True
for filepath in staged_files:
只检查markdown文件
if not filepath.endswith('.md'):
continue
filename = os.path.basename(filepath)
执行检查
name_ok = check_filename(filename)
meta_ok = check_metadata(filepath)
if not (name_ok and meta_ok):
all_passed = False
if all_passed:
print("\033[92m[成功] 所有文件符合档案制度规范，允许提交。\033[0m")
sys.exit(0)
else:
print("\033[91m[失败] 存在不符合规范的文件，请修正后再次提交。\033[0m")
sys.exit(1)
if __name__ == "__main__":
main()

五、配置Git Hooks强制执行制度

编写好脚本后，需要将其挂载到Git的 pre-commit 钩子中。这样，任何人执行 git commit 命令时，脚本都会自动运行。

在项目根目录下执行以下操作：

1. 赋予脚本执行权限（Linux/macOS）：

chmod +x pre_commit_check.py

2. 安装钩子：

我们需要在 .git/hooks/ 目录下创建一个 pre-commit 文件（无后缀），并调用我们的Python脚本。

cat > .git/hooks/pre-commit << 'EOF'
!/bin/sh
python pre_commit_check.py
EOF

chmod +x .git/hooks/pre-commit

touch "test_doc.md"

git add test_doc.md
git commit -m "测试错误文件"

touch "TECH-20231027-ARCHIVE-002.md"

git add TECH-20231027-ARCHIVE-002.md
git commit -m "测试缺少元数据"

cat > "TECH-20231027-ARCHIVE-003.md" << 'EOF'
author: 李四
department: 技术部
date: 2023-10-27
version: v1.0
classification: internal
档案制度建设测试
这是正文内容，符合所有规范。
EOF

git add TECH-20231027-ARCHIVE-003.md
git commit -m "提交合规档案"