analysis-documentation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

Confirm audience and scope — determine whether the primary reader is technical (data team), business (stakeholders), or both. For mixed audiences, use a tiered structure. See
```
references/audience_depth_guide.md
```
for calibration.
Write the business context section — state the business question, the stakeholders who requested the analysis, the decisions it informs, and the success criteria.
Document data sources — for each source, record the table or file, date range, row count, key columns, and any known quality issues or exclusions applied.
Write the methodology section — describe the analytical approach, tools and library versions, key assumptions, and important decisions made (and alternatives considered). Reference the assumptions log if one exists.
Record results — include key metrics and statistics, embed or link visualisations with descriptive captions, and present findings in order of importance.
Write the insights, recommendations, and reproducibility section — connect each finding to a business implication and a next action. Document the steps required to reproduce the analysis (data access, environment, execution order). Use
```
assets/analysis_doc_template.md
```
as the structure.

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

```
assets/analysis_doc_template.md
```
— completed analysis document covering context, data, methodology, results, and reproducibility
Linked or embedded visualisations and code references