agentsclimarketplace

Doc generation

Skill LisonEvf/finance-skills/skills/development/doc-generation

Generates documentation for trading and financial code: strategy documentation, API references, usage examples, README files, and inline code comments. Trigger when the user wants to document trading code or generate project documentation.From its SKILL.md

Install
npx -y skills add LisonEvf/finance-skills --skill doc-generation

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

One thing to look at

  • 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.

SKILL.md

1.6 KB, as published. Nobody here has run it

Documentation Generation

Creates clear, structured documentation for financial codebases.

Real Code Reference

  • tradinglearn/main.py — interactive CLI entry, good candidate for README docs
  • tradinglearn/strategies/macd_strategy.py — needs strategy documentation (params, logic, usage)
  • tradinglearn/pytdx2/CLAUDE.md — example of good project-level documentation
  • tradinglearn/pytdx2/demo.py — usage examples for all API calls

Output Types

  • Strategy docs: parameters, logic description, assumptions, expected performance
  • API docs: function signatures with parameter descriptions, return types, examples
  • README: project overview, quick start, installation, dependencies
  • Inline comments: explain non-obvious financial logic, formula references

Strategy Documentation Template

# Strategy Name

## Overview
One-sentence description of the core idea.

## Signal Logic
How entry/exit signals are generated, with formulas.

## Parameters
| Parameter | Default | Description |
|-----------|---------|-------------|
| fast | 12 | Short EMA period |

## Risk Management
Stop-loss, position sizing, and risk controls.

## Usage
\`\`\`python
strategy = MyStrategy(param=value)
signals = strategy.generate_signals(data)
\`\`\`

Keep looking

Skills are one crate of 609,689. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.