SudoDocs Guides

Everything you can do in the SudoDocs web app at app.sudodocs.com, split by who's doing it.

Get started

• Sign In and Create an Account: sign in with a password, Google, or company SSO; create an organization; accept an invitation.
• Profile & Security: change your password and turn on two-factor authentication.

For administrators

Set up SudoDocs for your organization from the Admin Dashboard.

• Connect repositories with Connect with GitHub or a token.
• Configure the Knowledge Base so every draft follows your style guide.
• Invite and manage users, and set your organization's sign-in policy.
• See all admin tasks

For writers

Draft, review, and ship documentation from the Workspace.

• DocOps Assistant: ask questions about your code and docs.
• Releases and the Release Dashboard: your work and your team's, release by release.
• Docflows: documentation suggestions from pull requests and Jira tickets.
• Release notes: every release's notes, collected from Docflows, Slack and Jira, drafted for you and pushed to your docs.
• Capture: turn a live product into a walkthrough, recording, or annotated screenshot.
• See all user tasks

Automating with the CLI?

On an Enterprise plan, every admin task and most user tasks can also run from a terminal or CI/CD pipeline. See CLI & API.