创建一个 JSON 文件，其中包含新文档的实际内容。内容必须遵循 references/content_data_schema.md 中定义的结构。

内容结构：

{
  "metadata": {
    "title": "Document Title",
    "author": "Author Name",
    "version": "1.0",
    "date": "2025-01-15"
  },
  "sections": [
    {
      "type": "heading",
      "content": "Section Title",
      "level": 1,
      "number": "1"
    },
    {
      "type": "paragraph",
      "content": "Paragraph text content."
    },
    {
      "type": "table",
      "rows": 3,
      "cells": [
        ["Header 1", "Header 2"],
        ["Data 1", "Data 2"]
      ]
    }
  ]
}

支持的章节类型：

• heading - 带可选编号的标题
• paragraph - 文本段落
• table - 可配置行和列的表格
• page_break - 分页符

完整示例请参阅 assets/example_content.json。

步骤 3：生成新文档

使用提取的格式和准备好的内容生成新的 Word 文档。

python scripts/generate_document.py <format.json> <content.json> <output.docx>

示例：

python scripts/generate_document.py format_template.json new_content.json output_document.docx

结果：一个新的 .docx 文件，其中模板的格式已应用于新内容。

完整示例工作流程

用户提问：“我有一个研究任务文档。我需要再创建 5 个具有相同格式但内容不同的文档。”

1. 提取格式：

python scripts/extract_format.py research_task_template.docx template_format.json

1. 为每个新文档创建内容文件（content1.json, content2.json 等）

2. 生成文档：

python scripts/generate_document.py template_format.json content1.json document1.docx

python scripts/generate_document.py template_format.json content2.json document2.docx
# ... 对所有文档重复此操作

常见用例

公司文档模板

从公司模板中提取格式，并生成具有一致品牌标识的报告、提案或规范。

# 一次性：提取公司模板
python scripts/extract_format.py "Company Template.docx" company_format.json

# 对于每个新文档：
python scripts/generate_document.py company_format.json new_report.json "Monthly Report.docx"

技术文档系列

创建具有相同格式的多个技术文档（规范、测试计划、手册）。

# 从规范模板中提取
python scripts/extract_format.py spec_template.docx spec_format.json

# 生成多个规范
python scripts/generate_document.py spec_format.json product_a_spec.json "Product A Spec.docx"
python scripts/generate_document.py spec_format.json product_b_spec.json "Product B Spec.docx"

研究任务文档

包含的示例模板 (assets/hy_template_format.json) 展示了一个完整的研究任务文档格式，包含：

• 页眉中的审批/评审表格
• 多级编号（1, 1.1, 1.1.1）
• 技术规范表格
• 结构化章节

可将其用作类似技术文档的起点。

高级用法

自定义提取

修改 scripts/extract_format.py 以提取默认未涵盖的额外属性：

• 自定义 XML 元素
• 高级表格功能（合并单元格、边框）
• 嵌入对象
• 自定义属性

扩展内容类型

在 scripts/generate_document.py 中添加新的章节类型：

• 带标题的图片
• 项目符号或编号列表
• 脚注和尾注
• 自定义内容块

扩展指南请参阅 references/content_data_schema.md。

批量处理

创建一个包装脚本来生成多个文档：

import json
import subprocess

format_file = "template_format.json"
content_files = ["content1.json", "content2.json", "content3.json"]

for i, content_file in enumerate(content_files, 1):
    output = f"document_{i}.docx"
    subprocess.run([
        "python", "scripts/generate_document.py",
        format_file, content_file, output
    ])

依赖项

脚本需要：

• Python 3.7+
• python-docx 库：pip install python-docx

核心功能无需额外的依赖项。

资源

scripts/

• extract_format.py - 从 Word 文档中提取格式
• generate_document.py - 根据格式 + 内容生成新文档

两个脚本都包含内置帮助：

python scripts/extract_format.py --help
python scripts/generate_document.py --help

references/

• format_config_schema.md - 格式配置文件的完整模式
• content_data_schema.md - 内容数据文件的完整模式

有关文件结构和可用选项的详细信息，请阅读这些文档。

assets/

• hy_template_format.json - 从技术研究任务文档中提取的格式示例
• example_content.json - 展示所有章节类型的内容数据示例

创建自己的格式和内容文件时，可将这些作为参考。

故障排除

输出中缺少样式：确保内容数据中的样式 ID 与格式配置中的样式 ID 匹配。检查 format.json 中可用的样式 ID。

表格格式问题：验证内容数据和格式配置之间的表格维度（行/列）是否匹配。表格结构请参阅 format_config_schema.md。

字体显示不正确：某些字体可能无法在所有系统上使用。请检查引用的字体是否已安装。

缺少依赖项：安装所需的 Python 包：

pip install python-docx

提示

1. 首先使用示例进行测试：在提取自己的格式之前，使用附带的 hy_template_format.json 和 example_content.json 来理解工作流程。

2. 从简单开始：从基本的标题和段落开始，然后添加表格和复杂的格式。

3. 验证 JSON：在生成文档之前，使用 JSON 验证器检查内容数据文件。

4. 保留格式配置：存储提取的格式配置，以便在多个项目中重复使用。

5. 版本控制：在版本控制中跟踪格式配置和内容数据，以实现可重复的文档生成。

每周安装次数

129

仓库

iamzhihuix/happ…e-skills

GitHub 星标数

269

首次出现

2026年1月20日

安全审计

Gen Agent Trust HubPassSocketPassSnykPass

安装于

opencode111

codex102

gemini-cli99

cursor94

claude-code87

github-copilot84