TechWriter for Databases vs TypeDoc
TechWriter for Databases
techwriter.meTypeDoc
typedoc.orgSide by side
| Figure | TechWriter for Databases | TypeDoc |
|---|---|---|
| Price from | $49/mo | Free |
| Free plan | — | Yes |
| Free trial | Yes | — |
| Open source | — | — |
| Windows | Yes | — |
| Linux | — | Yes |
| API | — | Yes |
| Self-hosted | — | Yes |
| Plans published | 2 | 1 |
| Spec score · Documentation Generators | 7.6 (#20) | 8.0 (#10) |
| Output formats | It can generate PDF, Compiled Help (CHM), Word/RTF, HTML, XPS and XML documentation. | The default output is HTML, and TypeDoc can also write a JSON model describing the project. |
| Purpose | TechWriter for Databases uses database information to automatically produce reference documentation. | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. |
| Support | The maker lists support requests, product updates and online documentation, with the first 12 months of support included with a license purchase. | The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide. |
Plans
TechWriter for Databases
- TechWriter for Databases$179, paid once
- TechWriter Complete subscription license$49 a month
In their own words
TechWriter for Databases
TechWriter for Databases has no write-up on Specifiction yet; its figures are above.
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.