documentation_skill

Overview

This skill keeps project documentation accurate and aligned with the codebase for a Rust-based algorithmic trading bot. It defines what files to update, when to update them, and provides templates and conventions to ensure consistent, discoverable documentation. Use it to reduce drift between implementation and docs, improve onboarding, and streamline releases.

How this skill works

The skill inspects feature changes, architecture modifications, and user-facing behavior to determine required documentation updates. It prescribes specific files to edit (system overview, version changelog, strategy docs, Cargo.toml, Rustdoc comments) and supplies templates and checklists to guide each update. It also maps code changes to documentation locations so maintainers know exactly which docs to update.

When to use it

• After adding or changing a trading strategy
• When modifying core architecture or module structure
• Before a public release or tag
• When introducing new UI components or infrastructure changes
• After adding new validation, benchmark, or test patterns

Best practices

• Update GLOBAL_APP_DESCRIPTION.md with a clear system overview and sectioned details for any feature or architecture change
• Record every significant commit or release in GLOBAL_APP_DESCRIPTION_VERSIONS.md using the provided version entry template
• Follow SemVer rules and increment Cargo.toml only on releases, matching the documented change types
• Add Rustdoc comments to all new public functions following the documented conventions and include examples
• Keep docs/STRATEGIES.md current: include indicators, entry/exit conditions, parameters, and recommended use cases
• Ensure any new modules, tests, benchmarks, or UI components are reflected in the corresponding documentation paths

Example use cases

• Add a new momentum strategy: update docs/STRATEGIES.md and GLOBAL_APP_DESCRIPTION.md, add a version entry, and document public functions with Rustdoc
• Introduce a breaking API change: bump major version in Cargo.toml, update architecture and contributor docs, and add detailed migration notes
• Ship a performance optimization: record the change in GLOBAL_APP_DESCRIPTION_VERSIONS.md, update Performance and Infrastructure sections, and document benchmark scripts
• Add Binance paper-trading support: update Server Mode and Infrastructure sections, add new skills mapping, and document configuration and recommended risk settings