RDoc vs StepShot
RDoc
ruby.github.ioStepShot
stepshot.appSide by side
| Figure | RDoc | StepShot |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | Yes |
| Open source | — | — |
| macOS | — | Yes |
| Linux | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 3 |
| Spec score · Documentation Generators | 8.1 (#8) | 7.7 (#16) |
| Purpose | RDoc produces HTML and command-line documentation for Ruby projects, with `rdoc` and `ri` tools to generate and display it. | StepShot records real Mac workflows and uses AI to organize them into step-by-step tutorials, SOPs, and training documents. |
Plans
In their own words
RDoc
RDoc is free software for producing Ruby project documentation as HTML pages and command-line reference output. The `rdoc` command generates documentation, while `ri` displays it. It processes Ruby, C, and RBS source files, plus RDoc markup, Markdown, RD, and TomDoc documents. RBS declarations can describe classes, modules, methods, attributes, and constants, and can add comments or type signatures to matching Ruby source documentation. A local preview server watches source files and refreshes the browser after changes. It uses Ruby’s built-in TCPServer and needs no external gems, but provides neither HTTPS nor HTTP/2 and is intended only for local previews. RDoc reports documentation coverage with `rdoc -C`, or includes parameter names with `rdoc -C1`. Generation can be automated through Rake or the RDoc API. Aliki is the default theme; Darkfish is deprecated. Ruby 3.2.0 or newer is required for the current gem.
StepShot
StepShot is a macOS app that turns recorded workflows into step-by-step tutorials, standard operating procedures, and training documents. It captures activity through action-driven capture or screen recording, using cursor pauses as an additional cue for splitting recordings into steps. Users can edit steps and annotations, then export to PDF, Markdown, or HTML. Capture, editing, and all three export formats work locally without an internet connection. Optional AI assistance can suggest improvements to titles, descriptions, and step order; users review suggestions individually before applying them. Cloud planning requires a connection and a user-supplied OpenAI-compatible endpoint, API, and quota. The free plan costs nothing, allows unlimited capture and editing, and exports only the first 10 steps in Markdown or HTML. Pro costs 269 CNY, paid once and adds unlimited steps, PDF export, branding, optional cloud planning, and activation on two devices. Team costs 899 CNY, paid once and adds five-device activation, shared brand presets, bulk licensing, centralized invoicing, and priority feedback handling. StepShot requires macOS 14 or later and supports Apple Silicon and Intel.