用途
Project Scaffold 用于初始化和管理研究项目的目录结构。没有它时,每个技能都需要询问数据位置和输出位置;使用脚手架后,项目拥有统一的规范路径,各技能可据此读取配置、检查前置条件并记录状态,同时留下可复现的审计轨迹。
项目类型
工具支持三种项目类型:
- 定性(qualitative):适用于访谈研究、民族志、内容分析,关键目录包括 transcripts、codebook、memos。
- 定量(quantitative):适用于调查、实验、二手数据分析,关键目录包括 raw_data、scripts、models、figures。
- 混合(mixed):同时包含定性与定量两套目录。
两种模式
- 新建项目:创建完整目录结构和空白元数据文件。启动后询问项目标题(必填)、项目类型(必填)、研究问题(建议填写)、目标期刊(可选)以及新模式。
- adopt 已有项目:将现有目录映射到规范路径而不移动文件。例如指定数据在 analysis/、文献在 lit-review/pdfs/。
工作流程
- 收集项目信息后,若项目目录还不是 Git 仓库,运行
git init;创建结构后执行初始提交git add -A && git commit -m "project-scaffold: Initial project structure"。下游技能统一使用 Git 做版本追踪,不创建带版本后缀的副本。 - 按类型创建或映射目录结构。定性项目包含 data/raw、data/clean、analysis/codes、analysis/memos、analysis/outputs、library/pdfs、library/markdown、literature/database、literature/notes、literature/synthesis、drafts/sections、drafts/submission、submissions 等。定量项目包含 data/raw、data/processed、data/codebooks、scripts/cleaning、scripts/analysis、scripts/visualization、models、figures、tables、library、literature、drafts 等。混合方法项目合并两套结构。公共文件包括 references.bib、project.yaml、progress.yaml、README.md。
- 写入 project.yaml 和 progress.yaml,其中 schema_version 为 1;遇到更新版本时提示但仍继续。
- 生成 README,展示项目概览与当前状态。
- 向用户报告创建内容和后续步骤。
进度追踪
progress.yaml 按项目类型预设不同阶段:定性项目包含文献检索与综合、沉浸、编码、解释、综合、理论/方法/发现/书挡写作、验证与修订;定量项目包含文献阶段、数据获取与清洗、EDA、建模、稳健性、可视化、表格、写作及复现检查;混合方法项目额外包含定性与定量两条线的阶段以及整合阶段。各阶段初始状态为 not_started,由后续技能完成时更新。
命令
/project-scaffold:创建新项目结构。/project-scaffold adopt:将已有项目映射到规范结构。/project-scaffold status:生成进度仪表板,列出已发现产物、状态表、建议的下一步和待完成质量检查。/project-scaffold update:重新扫描文件系统并更新 progress.yaml。
文件系统扫描
定性产物识别:路径内 .txt、.md、.docx 视为 transcripts;codebook.md 或 codebook.yaml 视为 codebook;quote-database.md 或 quotes.json 视为引文库;.md 视为 memos。定量产物识别:.csv、.dta、.sav、.xlsx 为原始数据;.csv、.parquet、.rds 为处理后数据;.R、.py、.do 为脚本;.rds、.pkl、.joblib 为模型;.png、.pdf、.svg 为图;.tex、.html、*.csv 为表。
与其他技能的集成
research-coordinator 在会话开始时检查 project.yaml,缺失时调用本工具,读取 progress.yaml 生成仪表板,并按项目类型路由到相应技能。其他技能通过读取 project.yaml 获取路径(如按 qualitative 或 quantitative 选择数据路径,并获取 references.bib、pdfs、markdown 路径),完成后将状态写回 progress.yaml。
适用场景与限制
适用于需要跨多个技能协作、强调路径规范与可复现性的社会科学研究项目管理。主要限制包括:仅支持上述三种项目类型;当前资料未说明安装方式、收费模式或具体运行环境要求,这些信息暂未提供。