Data Doc Writer
Use when writing or improving data documentation for warehouse tables, metrics, dashboards, SQL jobs, data products, or handover materials so other people and agents can understand data purpose, grain, fields, logic, ownership, and usage constraints. 中文触发词:数据文档、字段字典、表说明、交接文档、数据资产说明。
Install
npx skills add shisuidata/ss-data-skills --skill data-doc-writergit clone --depth 1 https://github.com/shisuidata/ss-data-skills.git /tmp/ss-data-skills
mkdir -p ~/.claude/skills
cp -r /tmp/ss-data-skills/skills/data-doc-writer ~/.claude/skills/data-doc-writerPersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.md
# Data Doc Writer ## 目标 把表结构、SQL、指标口径、看板说明或任务逻辑整理成可交接、可维护、可复用的数据文档。 这个 Skill 的重点不是写漂亮文案,而是降低数据资产使用和维护成本。 ## 使用场景 使用这个 Skill,当用户需要: - 给新上线的数仓表写说明文档 - 给指标、看板或数据产品补使用说明 - 把 SQL 任务逻辑整理成交接文档 - 做数据资产盘点、知识库沉淀或新人 onboarding - 为检索系统、语义层或自动化工具准备结构化数据说明 ## 不适用场景 不要使用这个 Skill 处理: - 从业务需求推导表结构,应使用 `table-design-advisor` - 审查 SQL 正确性,应使用 `sql-reviewer` - 生成质量规则,应使用 `data-quality-rule-generator` - 写分析报告,应使用 `data-analysis-report-writer` - 在缺少表名、用途、字段或计算逻辑时编造文档 ## 输入信息 最少输入: - 文档对象:表、指标、看板、SQL 任务或数据产品 - 用途说明 - 字段列表、指标列表或主要逻辑 推荐输入: - 表名、主题域、分层、数据粒度 - 主键、分区字段、更新频率、保留周期 - 字段名称、类型、含义、枚举值、是否可空 - DDL、生产 SQL、`eda.py` 的体检结果(可以直接生成初稿) - 上游来源、下游使用方、负责人 - SQL 或伪代码 - 指标口径、边界条件和常见误用 - 数据质量规则和 SLA ## 上下文建议 优先使用这些模板准备上下文: - [表设计上下文模板](../../context/templates/table-context.md):适合表说明和字段字典 - [SQL 审查上下文模板](../../context/templates/sql-review-context.md):适合 SQL 任务文档 - [指标上下文模板](../../context/templates/metric-context.md):适合指标口径文档 - [报告上下文模板](../../context/templates/report-context.md):适合看板或数据产品说明 如果文档面向特定业务域,建议补充行业上下文: - [电商行业上下文](../../context/industries/ecommerce.md) - [SaaS 行业上下文](../../context/industries/saas.md) - [内容社区行业上下文](../../context/industries/content-community.md) 上下文不足时,输出可填写的文档骨架,并把缺失信息列为待补充项。 ## 写作流程 1. 识别文档对象和目标读者:开发、分析、业务、管理者或工具使用方。 2. 提炼数据用途、业务含义、统计粒度和使用边界。 3. 整理字段字典、指标口径、计算逻辑、上下游关系。 4. 标记风险:易误用字段、延迟、历史变更、口径限制、权限限制。 5. 给出查询示例或使用示例。 6. 形成可维护的 Markdown 文档,并保留待补充清单。 ## 可用脚本 有 DDL、SQL 或体检结果时,先生成草稿,再补业务含义:
Details
- Skill name
data-doc-writer- Repository
- shisuidata/ss-data-skills
- Path
skills/data-doc-writer/SKILL.md- License
- MIT
- Repo updated
- 8 November 2026
FAQ
What does the Data Doc Writer skill do?
Use when writing or improving data documentation for warehouse tables, metrics, dashboards, SQL jobs, data products, or handover materials so other people and agents can understand data purpose, grain, fields, logic, ownership, and usage constraints. 中文触发词:数据文档、字段字典、表说明、交接文档、数据资产说明。
How do I install the Data Doc Writer skill?
skills CLI (Claude Code, Cursor, Codex and more): npx skills add shisuidata/ss-data-skills --skill data-doc-writer. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is Data Doc Writer popular?
It lives in shisuidata/ss-data-skills, which has 9 GitHub stars and 0 forks.
Related skills
Ab Test Analysis
9shisuidata/ss-data-skills
Use when designing, checking, or interpreting A/B tests and experiments. Computes significance, confidence intervals, sample ratio mismatch, power, CUPED, and sample size with a bundled zero-dependency script, then judges validity risks, guardrails, and ship/iterate/rollback decisions and renders an HTML experiment report. 中文触发词:A/B 实验、AB 测试、实验解读、显著性、样本量计算、能不能全量。
Business Root Cause Analysis
9shisuidata/ss-data-skills
Use when diagnosing business metric changes or anomalies such as GMV decline, conversion drop, retention loss, churn increase, revenue change, lead decline, or active user fluctuation with a structured root cause analysis plan. 中文触发词:指标归因、为什么下降、异常排查、GMV 下滑、指标波动原因。
Daily Report Writer
9shisuidata/ss-data-skills
Use when writing a concise daily report, daily worklog, standup update, shift handoff, or end-of-day summary for data analysis, data development, BI, governance, or operations work. 中文触发词:日报、日终同步、站会发言、值班交接。
Data Incident Postmortem Writer
9shisuidata/ss-data-skills
Use when writing a data incident postmortem for failed partitions, wrong dashboard numbers, metric definition changes, SQL logic bugs, backfill mistakes, SLA misses, or data pipeline incidents. 中文触发词:数据事故复盘、事故报告、看板数字错了、补数事故。
Weekly Monthly Report Writer
9shisuidata/ss-data-skills
Use when writing or polishing weekly reports, monthly reports, project updates, work summaries, performance reviews, or upward status reports for data, analytics, engineering, or operations work. 中文触发词:周报、月报、项目进展、向上汇报、绩效素材。
Apify Content Analytics
9huytran1120/vietnam-agentic-skills
Track engagement metrics, measure campaign ROI, and analyze content performance across Instagram, Facebook, YouTube, and TikTok.
Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.