Skip to content
SPECIFICTION
Get listed

StepShot vs TypeDoc

StepShot

stepshot.app

TypeDoc

typedoc.org

Side by side

FigureStepShotTypeDoc
Price fromFreeFree
Free planYesYes
Free trialYes—
Open source——
macOSYes—
Linux—Yes
API—Yes
Self-hosted—Yes
Plans published31
Spec score · Documentation Generators7.7 (#16)8.0 (#10)
IntegrationsCloud planning uses an OpenAI-compatible endpoint that the user supplies; the pricing page says users provide their own API and quota.The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes.
PurposeStepShot records real Mac workflows and uses AI to organize them into step-by-step tutorials, SOPs, and training documents.TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model.

Plans

StepShot

  • FreeFree
  • Pro269 CNY, paid once
  • Team899 CNY, paid once

StepShot pricing →

TypeDoc

  • Free and open sourceFree

TypeDoc pricing →

In their own words

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.

Visit stepshot.app

TypeDoc

TypeDoc is a free TypeScript documentation generator that turns source comments into HTML pages or a JSON model. It builds from project exports and follows re-exports, allowing members declared elsewhere to appear in documentation. TSDoc and JSDoc tags are extracted, Markdown is accepted in comments, and fenced code blocks receive Shiki syntax highlighting. HTML and JSON are built in; Markdown output needs a plugin such as typedoc-plugin-markdown. A default theme is included, while plugins can add themes, alter conversion and symbol organization, or change display. Custom CSS and JavaScript can further adjust generated pages. Configuration can come from an options file, package.json, or tsconfig.json. TypeDoc runs on Node.js, uses the TypeScript compiler, and supports the current Node.js LTS or newer. For npm monorepos, the packages entry-point strategy can combine package documentation into one site. The project is Apache-2.0 licensed. Documentation warns that global installation can separate plugins and themes from the intended TypeDoc installation.

Visit typedoc.org