用途:把研究项目文档按结构化方式组织,区分内部工作文件与可对外分享内容,便于开发中查找文档、准备分享包、维护整洁专业的文档并协作。
主要能力:提供推荐目录结构,如 data_descriptions、methods、results、reference 为可分享目录,progress、action_reports、todos、internal、deprecated 为内部目录;给出各目录的用途、应包含内容与命名模式匹配规则;提供分享包选择清单(SHARE_INCLUDE 与 INTERNAL_EXCLUDE);说明基于目录过滤优于文件模式匹配,并给出 share-project 命令中的过滤实现思路。
使用方式:新项目可用 mkdir -p documentation/{data_descriptions,methods,results,reference,progress,action_reports,todos,internal,deprecated} 创建结构,并创建 documentation/README.md 索引;已有项目建议逐步重组:创建新结构、移动文件、更新引用、测试 notebook 仍可用。分享时仅包含 data_descriptions、methods、results、reference,排除 progress、action_reports、todos、internal、deprecated、logs、working_files。
适用场景:研究项目文档管理、分享包制作、文档迭代与归档、团队协作。
限制:资料未提供具体安装命令、收费、平台或效果数据;迁移细节需参考 migration-guide.md,MANIFEST 更新参考 manifest-updates.md,版本控制与示例参考 version-control-and-examples.md。