展开知识库目录
课题组怎样统一文献、实验、代码和写作记录
课题组规范不是统一文件名这么简单。文献、样本、实验、数据、代码、分析和写作要共享项目标识、版本、责任人和可追踪关系。
图 5 能发表,却没人知道它来自哪个数据文件和哪版代码
学生电脑里有 final_data.xlsx、final_data2.xlsx 和真的最终版.xlsx;实验记录在纸本,图片通过群聊传递,论文数字又在 Word 中手改。半年后审稿人要求重画图,团队只能猜当时用了哪批样本。
课题组需要的是可追踪系统:一个项目有稳定 ID;样本、数据、实验、代码、结果、图表和稿件通过 ID 与版本连接;每项记录有责任人、时间、存放位置和变更原因。工具可以不同,但关键元数据和交接规则必须共同遵守。
- 建立跨材料的项目与对象标识
- 让图表和结论回到数据与代码
- 形成备份、权限、交接和离组流程
每类材料格式不同,但都要回答谁、何时、什么版本、从哪里来
| 记录域 | 最低元数据 | 关键控制 |
|---|---|---|
| 文献 | 唯一文献 ID、完整引文、PDF 权限、笔记与原文位置 | 共享文献库去重,引用可回原文 |
| 样本/实验 | 样本 ID、批次、时间、操作者、方案版本、偏离、原始文件 | 身份映射隔离、审计轨迹、质控 |
| 数据 | 数据集 ID、来源、字段字典、清洗、访问级别、冻结版本 | 原始只读、派生可重建、敏感最小权限 |
| 代码/环境 | 仓库、提交、依赖、入口脚本、参数、随机种子 | 版本控制、评审、环境锁定 |
| 结果/图表 | 结果 ID、输入数据、代码提交、模型、单位、展示位置 | 自动生成,禁止 Word 内静默改数字 |
| 写作/决策 | 稿件版本、主张、证据、作者贡献、会议决定 | 单一工作稿、修改理由、作者批准 |
规范必须能被新人照做,也能被负责人抽查
- 01
定义项目和对象 ID
项目、样本、数据集、分析和结果使用稳定标识,禁止把姓名、日期和自由文本混成唯一身份。
- 02
建立目录与权威位置
规定原始数据、派生数据、代码、文档、结果和稿件的唯一存放位置;聊天附件和个人桌面不作为权威版本。
- 03
写命名与版本规则
文件名包含项目、对象、内容和必要日期;版本由版本控制或清单管理,不用 final2。原始数据保持只读。
- 04
设置权限和备份
按角色最小授权,身份映射、敏感数据和公开材料分区;定义自动备份、异地副本、恢复测试和离组撤权。
- 05
把图表纳入结果血缘
每个主要结果记录数据版本、代码提交、环境、分析样本、单位和稿件位置,确保可一键或按文档重建。
- 06
建立例行检查和交接
每周检查新增记录,每月抽一个结果端到端复现;人员离组前完成数据、代码、实验本、权限和未决问题交接。
先发布最小可执行版,再根据真实返工更新
规范目录
README 应回答的内容
research-standard/ 00_scope-and-roles.md # 适用项目、负责人、审批和例外 01_project-and-object-ids.md # 项目/样本/数据/结果标识 02_folder-and-naming.md # 权威位置、目录和命名 03_literature-records.md # 文献、笔记和引用定位 04_lab-and-sample-records.md # 实验、样本、批次、偏离、质控 05_data-governance.md # 字典、权限、冻结、共享、保留 06_code-and-environment.md # Git、依赖、入口、复现 07_result-lineage.md # 数据—代码—结果—图表—稿件 08_writing-and-authorship.md # 工作稿、主张、贡献、批准 09_backup-and-recovery.md # 备份范围、异地副本、恢复测试 10_onboarding-and-offboarding.md # 培训、权限、交接、撤权 templates/ # 台账与检查表 examples/ # 脱敏合格示例
结果血缘表
每个关键结果一行
result_id,project_id,question,data_version,analysis_sample,code_repo,commit,environment,command_or_entry,parameters,output_file,unit,figure_table,manuscript_location,owner,reviewer,created_at,status
R001,P001,{问题},{数据版本},{样本},{仓库},{提交},{环境},{入口},{参数},{输出},{单位},{图表},{稿件位置},{负责人},{复核人},{时间},已冻结目录只是规范骨架。涉及人类参与者、临床、基因、商业或其他敏感数据时,应加入相应伦理、法律和机构制度。
随机抽一张已发表或待投图,团队应能在限定时间内重建
记录规范要同时服务可复现、数据管理、隐私和团队责任
一手来源UK Data Service:Document your data编辑依据本单位伦理、数据安全、知识产权与档案制度
参考数据文档、元数据、版本和长期理解所需记录。
一手来源NIH Data Management and Sharing Policy参考数据管理、保存和共享计划;具体项目适用规则仍由资助方与机构决定。
一手来源CRediT Taxonomy用于明确贡献角色并支持作者讨论,不能单独决定作者资格和顺序。
决定访问、共享、保存、离组和对外发布边界,优先级高于通用模板。
