AI生成标准Markdown文件的提示词指南

核心目标

生成能被智能解析器正确提取并保存到对应目录的Markdown文档。

基本原则

1. 标题格式规则

正确格式：

# 目录名/文件名.扩展名

示例：

# src/main.py
# utils/helper.py
# config/settings.yaml
# README.md

如果不指定目录：

# 文件名.扩展名
# 这是描述性标题

2. 内容格式规则

代码文件：

# src/main.py

python

!/usr/bin/env python3

print(“Hello, World!”)

```

**文本文件：**

markdown

docs/README.md

项目说明文档

这是一个Markdown文件，可以包含：

• 项目说明
• 使用指南
• 其他信息

### 3. 多文件示例

markdown

src/main.py

def main():
    print("Hello")

utils/math_utils.py

def add(a, b):
    return a + b

config/app.yaml

app:
  name: "My App"
  version: "1.0"

README.md

这是项目的说明文档…

## 详细提示词

markdown
请按照以下规范生成Markdown文档，以便程序能自动提取文件并保存到相应目录：

生成规范

1. 标题格式

• 使用标准的Markdown标题（# 后跟空格）
• 如果文件需要放在子目录中，标题格式为：# 目录名/文件名.扩展名
• 如果文件放在根目录，标题格式为：# 文件名.扩展名 或 # 描述性标题
• 示例：
• # src/main.py → 保存为 src/main.py
• # utils/helper.py → 保存为 utils/helper.py
• # README.md → 保存为 README.md
• # 项目说明 → 保存为 项目说明.txt（自动推断扩展名）

2. 内容格式

• 代码文件：标题后跟代码块

  # 文件名.扩展名

编程语言
代码内容

  ```

- **文本文件**：标题后跟Markdown文本

markdown
# 文件名.md
文本内容…

- **配置文件**：标题后跟对应的代码块

markdown
# config/settings.yaml

  配置内容

### 3. 文件顺序
- 按逻辑顺序排列文件（如：main.py → 辅助文件 → 配置文件 → 文档）
- 每个文件之间用空行分隔

### 4. 特殊处理
- **无扩展名标题**：程序会自动推断文件类型

markdown
# 数据库连接配置

  {
    "host": "localhost",
    "port": 3306
  }

→ 保存为 数据库连接配置.json

• 纯文本标题：

  # 项目说明
  这是一个纯文本文件...

→ 保存为 项目说明.txt

生成示例

请按照以下模板生成：

# 项目名称文件结构

# src/main.py

python

!/usr/bin/env python3

“””
主程序文件
“””

def main():
print(“程序启动”)

if name == “main“:
main()

# src/utils/helper.py

python
def helper_function():
return “辅助功能”

# config/settings.yaml

yaml
app:
name: “示例应用”
version: “1.0.0”

# docs/README.md
# 项目说明

这是一个示例项目...

## 使用方法
1. 安装依赖
2. 运行程序

# requirements.txt

requests==2.28.0
pytest==7.2.0

# 测试脚本

python
def test_function():
assert 1 + 1 == 2

```

## 重要提醒
1. **不要**添加额外的目录总览或文件列表
2. **不要**在标题中添加额外的符号（如：`# `项目文件` `）
3. **不要**使用嵌套代码块
4. **确保**每个标题对应一个完整的文件内容
5. **保持**文件内容的完整性

## 示例生成请求

请生成一个Python项目的Markdown文档，包含以下文件：

1. 主程序 main.py 放在 src 目录
2. 工具函数 utils.py 放在 src 目录
3. 配置文件 config.json 放在 config 目录
4. 说明文档 README.md
5. 依赖文件 requirements.txt

要求：

• 按照标准格式生成
• 每个文件有实际内容
• 代码要有注释

## 完整模板

markdown

[项目名称]

[可选的简要说明]

[目录路径]/[文件名].[扩展名]

[文件内容]

[另一个文件名]

[文本内容或代码块]

[更多文件…]

按照这个格式生成的Markdown文档可以被智能解析器正确解析，自动创建目录结构并保存文件。

给AI的具体提示词

你是一个代码生成助手，需要按照以下严格规范生成Markdown文档：

## 规范要求

### 1. 标题格式
- 必须使用：`# 路径/文件名.扩展名`
- 路径和文件名使用英文（可用数字、下划线）
- 示例：
  - `# src/main.py`
  - `# utils/helper_functions.py`
  - `# config/settings.json`

### 2. 内容格式
- 每个标题后立即跟对应的内容
- 如果是代码文件，使用代码块：

markdown
# 文件名.py

  代码内容

- 如果是文档文件，直接写内容：

markdown
# README.md
文档内容…

### 3. 文件结构
- 不要添加目录总览
- 不要添加文件列表
- 每个文件独立处理
- 文件之间用空行分隔

### 4. 命名规则
- 目录名：英文小写，用下划线分隔
- 文件名：英文，带适当扩展名
- 避免特殊字符和中文标点

## 响应格式
只输出符合上述规范的Markdown文档，不添加额外说明。

## 示例响应

markdown

src/main.py

#!/usr/bin/env python3

def main():
    print("Hello, World!")

if __name__ == "__main__":
    main()

src/utils/string_utils.py

def capitalize_words(text: str) -> str:
    """将每个单词首字母大写"""
    return ' '.join(word.capitalize() for word in text.split())

config/app_config.yaml

database:
  host: localhost
  port: 5432

server:
  port: 8000

README.md

项目说明

这是一个示例项目…

现在请按照这个规范生成一个包含多个文件的Markdown文档。

简洁版提示词（直接给AI用）

生成标准Markdown文档的规范：

1. 标题格式：# 目录/文件名.扩展名
2. 代码文件用代码块包裹
3. 文本文件直接写内容
4. 不要添加目录总览
5. 每个文件独立处理

示例：
# src/main.py

python
print(“Hello”)

# README.md
这是说明文档...

严格按照这个格式生成，不要添加额外内容。

使用这些提示词，你可以让其他AI生成能被正确解析的标准化Markdown文档。

页面： 123