vault backup: 2026-02-24 07:55:02
This commit is contained in:
@@ -0,0 +1,106 @@
|
||||
# Obsidian 仓库评审报告(QMD 驱动)
|
||||
|
||||
**评审日期**: 2026-02-03
|
||||
**评审范围**: 结构、文档、工作流、模板、脚本、维护一致性
|
||||
**评审方法**: 使用 QMD 索引与检索,对核心说明文档与工作流进行抽样评审
|
||||
**索引概况**: 639 个 Markdown 文档(QMD index)
|
||||
|
||||
---
|
||||
|
||||
## 总体评分
|
||||
|
||||
**综合得分: 86 / 100(成熟度:可持续运作,局部一致性需收敛)**
|
||||
|
||||
### 评分维度
|
||||
|
||||
1. 信息架构与 PARA 落地(18/20)
|
||||
2. 文档清晰度与可执行性(16/20)
|
||||
3. 工作流设计与可持续性(16/20)
|
||||
4. 模板与元数据规范(14/15)
|
||||
5. 自动化与脚本可用性(11/15)
|
||||
6. 一致性与去重(11/15)
|
||||
|
||||
**加权说明**: 结构与可执行性优先,其次是自动化与一致性。
|
||||
|
||||
---
|
||||
|
||||
## 主要优点
|
||||
|
||||
1. **结构清晰且 PARA 有完整说明**
|
||||
README 对 PARA 与文件结构的解释完整,且与 `06_Metadata/WORKFLOWS.md` 形成“总览 + 细节”分层。
|
||||
核心目录(`00_Inbox` ~ `06_Metadata`)清晰,迁移与归档路径明确。
|
||||
|
||||
2. **工作流体系成熟,具备“简化版 + 过渡版 + 全量版”**
|
||||
`ULTRA_SIMPLE_WORKFLOW.md`、`WORKFLOW_TRANSITION_GUIDE.md`、`WEEKLY_REVIEW.md`形成明确层级,能覆盖不同熟练度与时间预算。
|
||||
|
||||
3. **元数据与模板库基础扎实**
|
||||
`06_Metadata/Templates` 与 `06_Metadata/WORKFLOWS.md` 给出通用 frontmatter 与模板结构,便于系统化扩展。
|
||||
|
||||
4. **附件管理有明确规则与脚本支持**
|
||||
`05_Attachments/README.md`与脚本(package.json scripts)形成闭环,降低手工成本。
|
||||
|
||||
---
|
||||
|
||||
## 关键问题与风险
|
||||
|
||||
1. **核心文档入口不一致**
|
||||
`README.md`、`QUICK_REFERENCE.md`、`06_Metadata/WORKFLOWS.md`对“入口/主线”的定义不一致,入口职责与跳转路径不明确。
|
||||
结果:新用户或助手会遇到“入口不清晰”的路径断裂。
|
||||
**证据**: `README.md` 仅提供概览与分散说明,未明确权威入口;`QUICK_REFERENCE.md` 以速查为主但缺少返回入口说明;`06_Metadata/WORKFLOWS.md` 作为详细参考但未说明与入口文档的关系。
|
||||
|
||||
2. **命令规范与示例存在冲突**
|
||||
文档示例中出现 `| wc -l`、`grep`、`find` 等复杂命令,但缺少“脚本允许、手动命令禁止”的清晰边界说明。
|
||||
结果:指导规则与示例出现冲突,影响一致性与可执行性。
|
||||
**证据**: `WEEKLY_REVIEW.md` 中 `ls 00_Inbox/ | wc -l`;`QUICK_REFERENCE.md` 中 `grep -r` 与 `find . -name`。
|
||||
|
||||
3. **文档层级存在“并行主线”**
|
||||
`README.md`、`QUICK_REFERENCE.md`、`06_Metadata/WORKFLOWS.md`均包含“顶层规范”,缺少明确的主线导航与分工说明。
|
||||
结果:对于“哪个是主入口”的认知不稳定,容易造成重复维护。
|
||||
**证据**: `README.md` 提供概览与流程,但未明确入口职责;`QUICK_REFERENCE.md` 自包含速查流程;`06_Metadata/WORKFLOWS.md` 标注“详细参考”但未说明与其他入口的关系。
|
||||
|
||||
4. **工具链命令调用不统一(pnpm vs npm)**
|
||||
README 仍出现 `npm run` 的写法,而 Quick Reference/WORKFLOWS 使用 `pnpm`。
|
||||
结果:新用户可能复制即失败,或以为存在两套脚本策略。
|
||||
**证据**: `README.md` 中 `npm run firecrawl:scrape` 与 `npm run firecrawl:batch`;`06_Metadata/WORKFLOWS.md` 中脚本示例为 `pnpm`。
|
||||
|
||||
---
|
||||
|
||||
## 建议(按优先级)
|
||||
|
||||
1. **补齐或明确 `CLAUDE.md` 的权威入口**
|
||||
选项 A:恢复并维护 `CLAUDE.md` 为唯一入口(推荐)
|
||||
选项 B:将 `CLAUDE-BOOTSTRAP.md` 重命名为 `CLAUDE.md`,并在 README/Quick Reference 全部指向该文件
|
||||
|
||||
2. **统一“命令规范”与脚本现实**
|
||||
如果希望禁用管道命令:
|
||||
- 将 `WEEKLY_REVIEW.md` 与脚本中管道命令替换为等价的简单命令
|
||||
如果仅限制“手动执行”而非脚本:
|
||||
- 在 `CLAUDE-BOOTSTRAP.md`中明确例外(脚本允许管道,交互指令禁止)
|
||||
|
||||
3. **统一工具调用方式**
|
||||
全部文档中统一为 `pnpm`,或新增一段“若未安装 pnpm 可用 npm run”的注释。
|
||||
|
||||
4. **建立“文档主线”导航**
|
||||
在 README 或 Quick Reference 中增加“权威文档入口”段落,并明确:
|
||||
- `CLAUDE.md` = 系统主入口
|
||||
- `QUICK_REFERENCE.md` = 速查
|
||||
- `WORKFLOWS.md` = 详细参考
|
||||
|
||||
---
|
||||
|
||||
## 结论
|
||||
|
||||
该仓库已经具备**成熟的知识管理与工作流体系**,文档覆盖广、结构清晰、脚本化良好。
|
||||
当前主要瓶颈是**入口一致性与规则冲突**,解决后可显著提升上手体验与可维护性。
|
||||
**评审日期与索引日期**: 本报告评审日期为 2026-02-03,索引统计日期与之保持一致。
|
||||
|
||||
---
|
||||
|
||||
## 评分依据(复核用)
|
||||
|
||||
- 结构与文档一致性是否可在 2-3 次跳转内定位主流程
|
||||
- 命令示例与规则是否一致、是否存在可执行冲突
|
||||
- 入口文档是否明确分工且互相可达
|
||||
- 关键流程是否有可追溯证据(文件路径 + 具体示例)
|
||||
|
||||
**建议:**优先完成“入口文档一致性”与“命令规则一致性”两件事,可将综合评分提升至 90+。
|
||||
+27
-17
@@ -6,24 +6,35 @@
|
||||
**Status**: Reference Documentation
|
||||
|
||||
> This is a detailed reference. For core rules, see `.claude/project-instructions.md`
|
||||
> Relationship: `README.md` is the entry point, `QUICK_REFERENCE.md` is the quick reference, and this document is the detailed workflow guide.
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Output Templates](#output-templates)
|
||||
2. [PARA Method Explained](#para-method-explained)
|
||||
3. [Naming Conventions](#naming-conventions)
|
||||
4. [Inbox Management](#inbox-management)
|
||||
5. [Attachments Management](#attachments-management)
|
||||
6. [Web Content Workflow](#web-content-workflow)
|
||||
7. [Writing Style Guidelines](#writing-style-guidelines)
|
||||
8. [Git Workflow](#git-workflow)
|
||||
9. [Daily Workflows](#daily-workflows)
|
||||
10. [Available Commands](#available-commands)
|
||||
11. [Best Practices](#best-practices)
|
||||
12. [Troubleshooting](#troubleshooting)
|
||||
13. [Memvid Workflows](#memvid-workflows)
|
||||
1. [Command Policy](#command-policy)
|
||||
2. [Output Templates](#output-templates)
|
||||
3. [PARA Method Explained](#para-method-explained)
|
||||
4. [Naming Conventions](#naming-conventions)
|
||||
5. [Inbox Management](#inbox-management)
|
||||
6. [Attachments Management](#attachments-management)
|
||||
7. [Web Content Workflow](#web-content-workflow)
|
||||
8. [Writing Style Guidelines](#writing-style-guidelines)
|
||||
9. [Git Workflow](#git-workflow)
|
||||
10. [Daily Workflows](#daily-workflows)
|
||||
11. [Available Commands](#available-commands)
|
||||
12. [Best Practices](#best-practices)
|
||||
13. [Troubleshooting](#troubleshooting)
|
||||
14. [Memvid Workflows](#memvid-workflows)
|
||||
|
||||
---
|
||||
|
||||
## Command Policy
|
||||
|
||||
- Manual commands in documentation use simple, copy-safe commands only
|
||||
- Avoid pipes, `grep`, `find`, or other complex shell constructs in manual steps
|
||||
- Complex operations belong in `pnpm` scripts
|
||||
- If `pnpm` is unavailable, use `npm run <script>` as a fallback
|
||||
|
||||
---
|
||||
|
||||
@@ -469,7 +480,7 @@ git status # Periodically check changes
|
||||
```bash
|
||||
git status # Review all changes
|
||||
git add . # Stage all changes
|
||||
git commit -m "vault backup: $(date +%Y-%m-%d\ %H:%M:%S)"
|
||||
git commit -m "vault backup: YYYY-MM-DD HH:MM:SS"
|
||||
git push # Sync to remote
|
||||
```
|
||||
|
||||
@@ -565,7 +576,7 @@ ls 00_Inbox/
|
||||
# 3. Commit changes
|
||||
git status
|
||||
git add .
|
||||
git commit -m "vault backup: $(date)"
|
||||
git commit -m "vault backup: YYYY-MM-DD HH:MM:SS"
|
||||
git push
|
||||
```
|
||||
|
||||
@@ -613,7 +624,6 @@ git push # Sync to remote
|
||||
cd D:\tmp\vault\my-vault # Vault root
|
||||
ls 00_Inbox/ # List inbox
|
||||
ls 01_Projects/ # List projects
|
||||
find . -type d | sort # Map all folders
|
||||
```
|
||||
|
||||
---
|
||||
@@ -717,7 +727,7 @@ find . -type d | sort # Map all folders
|
||||
**Lost Files**:
|
||||
- Check git history: `git log --all --full-history -- <path>`
|
||||
- Look in Archive folders
|
||||
- Search by content: use grep or Obsidian search
|
||||
- Search by content: use Obsidian search
|
||||
- Check recent commits for moves
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user