write-methods

What problem does it solve?

This Skill helps maintain a synchronized Methods section that accurately reflects the project's scripts and pipeline, ensuring that documentation stays in sync with code and improves reproducibility.

Core Features & Use Cases

• Generate or update the Methods section directly from the scripts in scripts/ and from the pipeline configuration (dvc.yaml/params.yaml).
• Bridge code and documentation by extracting purpose, inputs, outputs, and key parameters from script docstrings and pipeline definitions.
• Use Case: After adding a new preprocessing script or changing a model training step, run /write_methods to refresh the methods.md to match the current pipeline.

Quick Start

Ensure there is at least one script in scripts/ with a descriptive docstring, then run the /write_methods command to generate or update the methods documentation.