Rewriting the Enterprise Intro


Background

Our docs could be better! What we want from our docs:

  • Easy to scan navigation
  • Gets to the point
  • No business jargon
  • We don’t shy away from getting technical and detailed

What we have:

  • It’s out-dated in many places
  • Feels like marketing
  • Doesn’t have the right level of information, or it’s too hard to find the right information

The whole thing needs a refresh, imo.  Screenshots are outdated.  Placement of docs doesn't make sense

—Kirby on the Sales team



The Project

Covers all the pages in the Enterprise overview section: https://docs.readme.com/ent/docs/intro-to-readme-enterprise

  • Intro to ReadMe Enterprise
  • Enterprise FAQ
  • Security Overview
  • Migrating to ReadMe
  • Integrating into your Workflow

What we’re looking for:

There are lots of ways docs are done for products. ReadMe caters toward a technical audience, and the Enterprise offering is targeting specifically toward teams at larger orgs that need a solution that caters to many stakeholders:

  • Devs who want to work in Git
  • Technical writers who need to collaborate
  • Product manangers and designers who need to review or make quick updates, etc.

Our docs are read by prospects, existing customers, and used by the sales and marketing teams to showcase our product. They should be the best example of documentation on the internet.

Intro page is aesthetically pleasing and highlights our best enterprise features

Feedback from the sales team: "i would love a landing page like docs.readme.com/main list the main enterprise features in the same way with cards to simplify navigation

Outdated content

From the sales team: "then just a general update to make them current, like this page is wild that it still looks like this: https://docs.readme.com/ent/docs/enterprise-group-overview"



Additional Context

Key Enterprise Features:

  • Most will be highlighted on our pricing page: https://readme.com/pricing
  • Technical services: https://readme.com/services
  • Table stakes: Audit logs, SSO, custom JS; we do mention them, but we do not emphasize those as the leading reasons why Enterprise plans would be a good fit.
  • Reviews
    • We’re actively building this and it’s in beta, but Review features are:
      • Diff branches
      • Mark branches as ready for review
      • Assign reviewers
      • AI Agent checks branches against their custom styleguide
      • Notification when branch is ready
      • Reviewers can approve changes
      • Workflow management features
      • Review dashboard
    • I explain a bit here: https://docs.readme.com/ent/docs/enterprise-workflow-overview
  • Managing writers/quality/content
    • Editor and viewer roles (I explain here: https://docs.readme.com/ent/docs/user-roles)
    • Global reusable content (think synced content), components, glossary, and styleguide rules
      • Global here means it works across all their projects. Many Enterprise customers have just one project,  and some of hundreds—and everything in between.