64 lines
1.2 KiB
Markdown
64 lines
1.2 KiB
Markdown
---
|
|
tags: [config, agent, standards]
|
|
create time: 2026-04-17 11:29
|
|
update time: 2026-04-18
|
|
---
|
|
|
|
# 文件创建规范
|
|
|
|
## 核心规则
|
|
|
|
**所有新文件必须遵循以下结构:**
|
|
|
|
```yaml
|
|
---
|
|
tags: []
|
|
create time: YYYY-MM-DD HH:mm
|
|
---
|
|
|
|
# <标题>
|
|
|
|
## 概述
|
|
[简短描述]
|
|
|
|
## 正文
|
|
[内容]
|
|
|
|
## 关联笔记
|
|
- [[相关笔记]]
|
|
```
|
|
|
|
## 必填项
|
|
|
|
| 字段 | 格式 | 说明 |
|
|
|------|------|------|
|
|
| `tags` | 数组 | 必须存在 `[]`,智能填充相关标签 |
|
|
| `create time` | `YYYY-MM-DD HH:mm` | 当前系统时间 |
|
|
|
|
## 文档结构
|
|
|
|
1. **## 概述**: 简短描述文档内容,不要保留占位文本
|
|
2. **## 正文**: 主要内容,详略得当,注重拓展进阶
|
|
3. **## 关联笔记**: 相关笔记 Wiki-links,若无可移除
|
|
|
|
## 内容规范
|
|
|
|
- **代码示例**: 优先 Go (后端) + React/TS (前端)
|
|
- **图表**: 选择性使用 Mermaid
|
|
- **风格**: 详略得当,注重实用性
|
|
|
|
## Agent 执行步骤
|
|
|
|
1. 读取模板: `[[config/template/default-template.md]]`
|
|
2. 创建文件并填充 `create time`
|
|
3. 智能填充 `tags`
|
|
4. 替换占位文本为实际内容
|
|
5. 添加相关 Wiki-links
|
|
|
|
## 特殊情况
|
|
|
|
配置文件、开发文件等可灵活调整结构,但需保留:
|
|
- `tags` 字段
|
|
- `create time` 记录
|
|
- 清晰的组织结构
|