analysis-documentation

分析文档

使用场景

• 在与利益相关者分享分析前完成最终定稿
• 将分析移交给其他团队成员或留给未来的自己
• 归档定期开展的分析，以便之后以一致的方式重新运行
• 准备同行评审或正式审计
• 将探索性笔记本转换为参考文档

流程

1. 确认受众和范围 — 确定主要读者是技术人员（数据团队）、业务人员（利益相关者），还是两者兼有。对于混合受众，采用分层结构。请参阅 references/audience_depth_guide.md 进行调整。
2. 撰写业务背景部分 — 说明业务问题、提出分析请求的利益相关者、分析所支持的决策以及成功标准。
3. 记录数据来源 — 对每个数据源，记录表或文件、日期范围、行数、关键列，以及已知的数据质量问题或已应用的排除项。
4. 撰写方法部分 — 描述分析方法、工具和库版本、关键假设、重要决策及考虑过的替代方案。如果存在假设日志，请引用该日志。
5. 记录结果 — 纳入关键指标和统计数据，嵌入或链接可视化内容并附上描述性说明，并按重要性顺序呈现发现。
6. 撰写洞察、建议和可复现性部分 — 将每项发现与业务影响及后续行动关联起来。记录复现分析所需的步骤（数据访问、环境、执行顺序）。使用 assets/analysis_doc_template.md 作为结构。

技能所需的输入

• 最终代码（SQL、Python、笔记本）和输出（图表、表格）
• 业务问题和利益相关者背景
• 已确定的关键发现和建议
• 数据源详情（表、日期范围、样本量）
• 所用库和工具的版本

输出

• assets/analysis_doc_template.md — 完整的分析文档，涵盖背景、数据、方法、结果和可复现性
• 链接或嵌入的可视化内容和代码引用