SuperAPI AI 工具集

analysis-documentation

数据与分析

查看项目

更新于 10-15 17:15

技能介绍

用途

Analysis Documentation 是一个用于生成结构化、可复现分析文档的技能。它主要解决分析结果在分享、交接、归档、评审和审计过程中缺乏规范记录的问题,帮助将一次性的探索性分析转化为可长期参考和复用的文档。

主要能力

该技能覆盖分析文档的完整结构,包括:

  • 确认受众与范围:判断主要读者是技术团队、业务利益相关者还是两者兼有;对于混合受众,采用分层结构。可参考 references/audience_depth_guide.md 进行校准。
  • 撰写业务背景:说明业务问题、提出分析请求的利益相关者、分析所支持决策以及成功标准。
  • 记录数据来源:对每个来源记录表或文件、日期范围、行数、关键列,以及已知的数据质量问题或已应用的排除条件。
  • 编写方法论:描述分析方法、工具与库版本、关键假设、重要决策及考虑过的替代方案;如存在假设日志则引用。
  • 记录结果:包含关键指标与统计量,嵌入或链接可视化并附描述性标题,按重要性顺序呈现发现。
  • 撰写洞察、建议与可复现性:将每项发现与业务影响和后续行动关联,记录复现分析所需的步骤(数据访问、环境、执行顺序)。

使用方式

该技能需要以下输入:

  • 最终代码(SQL、Python、笔记本)和输出(图表、表格)
  • 业务问题与利益相关者背景
  • 已识别的关键发现与建议
  • 数据来源细节(表、日期范围、样本量)
  • 使用的库与工具版本

输出为 assets/analysis_doc_template.md,即一份完成的分析文档,覆盖上下文、数据、方法论、结果和可复现性,并包含链接或嵌入的可视化与代码引用。

适用场景

  • 在向利益相关者分享分析前定稿
  • 将分析交接给其他团队成员或未来的自己
  • 归档周期性分析,以便一致地重新运行
  • 准备同行评审或正式审计
  • 将探索性笔记本转化为参考文档

限制

资料中未提供关于该技能的具体平台限制、收费模式、价格、效果保证或额外使用步骤的说明。