RDoc vs TechWriter for Databases
RDoc
ruby.github.ioTechWriter for Databases
techwriter.meSide by side
| Figure | RDoc | TechWriter for Databases |
|---|---|---|
| Price from | Free | $49/mo |
| Free plan | Yes | — |
| Free trial | — | Yes |
| Open source | — | — |
| Windows | — | Yes |
| Linux | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 2 |
| Spec score · Documentation Generators | 8.1 (#8) | 7.6 (#20) |
| Purpose | RDoc produces HTML and command-line documentation for Ruby projects, with `rdoc` and `ri` tools to generate and display it. | TechWriter for Databases uses database information to automatically produce reference documentation. |
| Support | The project directs users to CONTRIBUTING.md for filing bug reports. | The maker lists support requests, product updates and online documentation, with the first 12 months of support included with a license purchase. |
Plans
TechWriter for Databases
- TechWriter for Databases$179, paid once
- TechWriter Complete subscription license$49 a month
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.
TechWriter for Databases
TechWriter for Databases has no write-up on Specifiction yet; its figures are above.