Docs that keep up,
whichever team you are on
Engineering ships it, support answers for it, product launches it. Paperkraft keeps the docs in step for all of them, and every change is a pull request your team reviews.
Docs that change with every merge
Engineers ship the code and move on. Paperkraft reads the merged pull request, finds every page it affects and opens one docs pull request with the change. Nobody has to remember the docs.
- Starts when
- A pull request merges
- You get
- One docs pull request, checked
- Reads the diff, not just the title
- Finds every page that mentions the change
- Runs your docs build before it opens anything
Tokens expire after 1 hour.
Tokens expire after 24 hours.
Fewer tickets that ask the same thing
When the same question keeps coming in, the docs are missing a page or saying the wrong thing. Paperkraft spots the pattern in your tickets and drafts the article that answers it.
- Starts when
- Repeat questions in Zendesk or Intercom
- You get
- A new or corrected help article
- Groups tickets that ask the same question
- Drafts the article in your help centre's voice
- Links the tickets it came from, for your review
Every launch documented
A feature is not finished until people can find out how to use it. Mention @paperkraft on the ticket or the release and it drafts the guide, the changelog entry and the pages that need a line changed.
- Starts when
- A ticket closes or a release is tagged
- You get
- Guide, changelog and page updates
- Starts from Jira, Linear or a Slack thread
- Drafts the guide in your house style
- Puts it in the right place in the sidebar
- Guide: Schedule a reportReady
- Changelog entryReady
- Reports overview, 1 lineReady
- Sidebar: Reports sectionNeeds review
API docs developers can trust
Developers stop trusting docs after the first example that does not run. Paperkraft keeps the reference in step with your API spec and runs code samples against a live API before they publish.
- Starts when
- Your OpenAPI spec changes
- You get
- Updated reference and tested samples
- Reads changes to your OpenAPI or Swagger spec
- Updates the reference and every guide that uses it
- Runs samples, so broken ones never publish
+ format: "csv" | "xlsx"
- Reference: export endpointUpdated
- curl sample run200 OK
- node sample run200 OK
Agents do the upkeep. Writers do the writing.
Most of a docs team's week goes on small fixes nobody notices until they are wrong. Paperkraft takes that queue, sorts it by risk and leaves your writers the work that needs a writer.
- Starts when
- Every change, every week
- You get
- A review queue sorted by risk
- Small fixes can merge on their own, if you allow it
- Anything bigger waits for a person
- One weekly digest of everything that changed
Start with the team that feels it most
Most teams start where the docs hurt today. Join the beta and we will set Paperkraft up on your docs repository with you.