write-methods

You can generate a methods section by running a command that extracts parameter values, pipeline configurations, and script docstrings to synchronize documentation with your computational research codebase.

To keep documentation in sync with a dvc pipeline, this Skill extracts pipeline definitions from dvc.yaml and params.yaml to automatically update the methods.md file whenever scripts are modified.

You need at least one script in a scripts/ directory with a descriptive docstring, alongside a pipeline configuration file like dvc.yaml, to successfully extract parameters and generate reproducibility notes.

While specifically designed for projects using a dvc.yaml pipeline configuration, the documentation generation relies on extracting data from script docstrings and can adapt to standard pipeline definitions.

Methods documentation falls out of sync when scripts are modified without refreshing the methods file, a problem solved by extracting purpose, inputs, and outputs directly from the updated script docstrings.

Yes, automatic inclusion of software versions and reproducibility notes is enforced by extracting data directly from script docstrings and pipeline configuration files during the methods generation process.