RedeDocs
RedeDocs automatically creates technical documentation for a SITS project, generated from source with optional AI enhancement. Run it as part of RedeRelease to update documentation with every release, so teams can onboard faster, operate safely, and avoid documentation drift.
What it does
Turn SITS project assets into clear, structured technical documentation that stays current.
Generate technical documentation
Create consistent docs for configuration, message flows, mappings, and operational runbooks.
Optional AI enhancement
Connect your organisation's hosted model endpoint to add plain-language explanations of what configuration does and summaries of what changed in each release. AI is opt-in: without it, documentation is still generated directly from source, and AI drafts are reviewed before they are published.
Update docs with every release
Run RedeDocs as a stage in RedeRelease so documentation for changed records is generated or updated with each release package and reviewed alongside the change.
Publishing integrations (roadmap)
Planned support to automatically update Jira, Confluence, and other university documentation stores.
How it works with RedeSentry and RedeRelease
RedeDocs is designed to be used alongside RedeSentry and RedeRelease. RedeSentry focuses on automated validation and risk detection, RedeDocs focuses on documentation generation and publishing, and RedeRelease carries both into a controlled release.
- RedeSentry: syntax checks, quality scoring, and PII/error detection
- RedeDocs: generated documentation, optional AI enhancement, and (roadmap) publishing into your tooling
- RedeRelease: controlled packaging and deployment, with documentation updated for each release