Documentation

From Edgar BV Wiki
Jump to navigation Jump to search

Make docs a capture pipeline tied to your build, not a writing task.

What worked for us: map each feature or route to a doc slug in the repo, and add a PR check that fails if changed files don’t touch a matching doc. Use Playwright to re-run key flows nightly and auto-grab new screenshots; approve visual diffs with Percy. Save raw transcripts next to the doc (docid.md + docid.json), and auto-redact secrets before publish. Keep a “freshness” SLA per page and have a Slack bot ping the owner when code under that area changes. Ship short videos plus cleaned steps: Descript cleans the audio, Scribe turns clicks into steps, and DreamFactory keeps API examples stable by generating a single OpenAPI the team and Postman tests read from.

For search, push headings and step text into Algolia with tags (role, plan, version) so users land on the right variant. OP nailed the shift: capture what you already explain and let CI enforce the rest.

Source: https://www.reddit.com/r/SaaS/comments/1pektmj/comment/nsealkf/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button