模板设计指南
这个文档记录了 Obsidian 模板的设计原则和最佳实践,用于指导模板的创建和维护。
核心设计原则
1. 自动化程度适中
- ✅ 自动生成基础信息(日期、周次、标题)
- ✅ 自动生成相关链接(前后周报、项目关联)
- ❌ 避免过度自动化(如复杂的统计数据计算)
2. 结构简洁实用
- 避免过多的子标题层级
- 每个模块内容控制在合理范围内
- 去除形式化的装饰元素(emoji、复杂表格)
3. 灵活性设计
- 提供留白区域,支持自由填写
- 模块化结构,可根据需要扩展
- 避免过于固定的填写格式
4. 语法规范
- Templater 语法:
<% tp.date.now() %>用于动态内容 - YAML frontmatter:清晰的元数据结构
- Obsidian 链接:
[[wikilink]]内部链接语法 - 任务格式:
- [ ]待办事项
5. 命名规范
- 文件名:
YYYY-Wxx格式(如2025-W41) - 便于排序和查找
- 符合时间管理习惯
标准模板结构
YAML Frontmatter
---
title: "模板名称 - 2025-W41"
tags:
- 类型
- 年份
created: <% tp.date.now('YYYY-MM-DD HH:mm') %>
---内容结构
# 标题
## 核心模块1
- [ ] 待办事项
## 核心模块2
- 简洁填写区域
## 核心模块3
- 留白式总结
---
相关链接常用 Templater 语法
日期相关
<% tp.date.now('YYYY') %> // 年份:2025
<% tp.date.now('MM') %> // 月份:10
<% tp.date.now('DD') %> // 日期:09
<% tp.date.now('w') %> // 周数:41
<% tp.date.now('YYYY-MM-DD') %> // 完整日期:2025-10-09
<% tp.date.now('YYYY-MM-DD', -7) %> // 7天前:2025-10-02
<% tp.date.now('YYYY-MM-DD', 7) %> // 7天后:2025-10-16周数计算
<% tp.date.now('YYYY') %>-W<% tp.date.now('w') %> // 格式:2025-W41
<% tp.date.now('YYYY', -7) %>-W<% tp.date.now('w', -7) %> // 上周
<% tp.date.now('YYYY', 7) %>-W<% tp.date.now('w', 7) %> // 下周自动链接生成
[[文档 - <% tp.date.now('YYYY') %>-W<% tp.date.now('w') %>]]
[[文档 - <% tp.date.now('YYYY', -7) %>-W<% tp.date.now('w', -7) %>]]避免的陷阱
- 过度形式化:太多装饰符号、emoji、复杂表格
- 字段冗余:重复的信息收集字段
- 语法错误:不正确的模板语法导致渲染失败
- 过于复杂:字段太多,填写负担重
- 缺乏灵活性:死板的结构无法适应实际使用
模板维护指南
定期检查
- 验证 Templater 语法正确性
- 检查自动链接是否有效
- 确保模块结构符合实际需求
优化方向
- 简化结构:定期审视是否有过度设计
- 提升易用性:根据使用反馈调整填写体验
- 增强功能性:在保持简洁的前提下添加实用功能
现有模板
周报模板
- 文件:
周报模板.md - 用途:每周工作总结和计划
- 特点:简洁结构,自动化日期和链接
- 模块:目标、工作、总结、计划
扩展建议
可考虑的模板类型
- 项目总结模板
- 会议记录模板
- 学习笔记模板
- 项目规划模板
功能增强
- 条件逻辑(使用 Templater 高级功能)
- 数据统计(轻量级)
- 多语言支持
创建时间:2025-10-09 最后更新:2025-10-09 维护者:Claude AI Assistant