Index of every page on this site: llms.txt
All skills
nimrodfisher avatar

/analysis-documentation

@9449d36
Run it yourself

Structured, reproducible analysis documentation. Use when documenting analysis findings, creating analysis notebooks, ensuring reproducibility, or building analysis archives for future reference.

Use this Skill: https://skilld.dev/gh/nimrodfisher/data-analytics-skills/analysis-documentation

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈55 tokens for metadata: the name and description. ≈525 when used: this file. ≈1.2k more on demand in 2 files.

Description uses 2.8% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈220 characters, or 2.8%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Analysis Documentation

When to use

  • Finalising an analysis before sharing it with stakeholders
  • Handing off an analysis to another team member or to a future self
  • Archiving recurring analyses so they can be run again consistently
  • Preparing for peer review or a formal audit
  • Converting an exploratory notebook into a reference document

Process

  1. 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.
  2. Write the business context section — state the business question, the stakeholders who requested the analysis, the decisions it informs, and the success criteria.
  3. 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.
  4. 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.
  5. Record results — include key metrics and statistics, embed or link visualisations with descriptive captions, and present findings in order of importance.
  6. 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.

Inputs the skill needs

  • Final code (SQL, Python, notebook) and outputs (charts, tables)
  • Business question and stakeholder context
  • Key findings and recommendations already identified
  • Data source details (tables, date ranges, sample sizes)
  • Library and tool versions used

Output

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

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts2mo4 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill provides a set of markdown templates and guidelines for documenting data analyses. It contains no executable scripts or security risks.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at 9449d36. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last month.

Activeupdated 7 months ago

README badge

README badge for nimrodfisher/data-analytics-skills/analysis-documentation