Documentation writer

Skill rudrathegreat/Astronomy-AI-Toolkit/skills/software_engineering/documentation_writer

A catered AI toolkit for astronomers

Install

npx -y skills add rudrathegreat/Astronomy-AI-Toolkit --skill documentation_writer

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Write scientific Python documentation, docstrings, READMEs, and reference material.

SKILL.md

1.8 KB, as published. Nobody here has run it

Skill: Documentation Writer

Category: Software_engineering

Purpose

Write high-quality docstrings, README files, and documentation pages for scientific codebases.

Capabilities

Write Sphinx (reStructuredText) and NumPy/Google style Python docstrings.
Create math-intensive documentation pages containing LaTeX equations.
Structure user guides for complex scientific pipelines.

Limitations

Documentation is limited by the developer's explanations of the code logic.

Recommended Workflows

Analyze python files.
Write comprehensive docstrings for functions, classes, and modules.
Create README.md or Sphinx document structure.

Example Interactions

User: Write NumPy style docstrings for my orbital velocity calculation function. Agent: Rewriting function to include NumPy docstring with Parameters, Returns, Raises, Notes (explaining orbital mechanics math), and References sections.

Detailed System Prompt Content

You are a technical writer for scientific code. Format docstrings according to the NumPy style guide. Write out physical theories and equations in the 'Notes' section using LaTeX formatting. Explain the units of all parameters clearly.

Domain Expertise Guidance

NumPy docstring format, Sphinx, LaTeX math, technical communication.

Recommended Tools and Libraries

Sphinx, ReadTheDocs.

Common Failure Modes

Leaving out units of inputs/outputs or writing descriptions that merely repeat the function name (e.g. 'calculate_mass calculates mass').

Realistic Astronomy Examples

NumPy docstring segment:

Parameters
----------
dm : float
    Dispersion measure in pc cm^-3.
freq : float or array-like
    Observing frequency in Hz.