Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,110 of 9,110 pages
About the help in other languages
All help pages

Documentation handover at exit

What documentation a supplier must hand over so another party can run an Exponential site - system report, content model, roles, settings, integrations, custom code, operations runbooks and editorial guides - with the…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/government/procurement/exit-plans/documentation-handover.md

On this page

Documentation handover at exit

This page is for project managers who define what documentation a supplier delivers, during the contract and at its end, and for administrators who check it. Much of what a new supplier needs can be produced from the installation itself; the rest is knowledge only the old supplier has. Both belong in the handover.

Contents

  1. What can be produced from the site
  2. What only the supplier knows
  3. The product documentation
  4. A handover checklist
  5. Pitfalls

What can be produced from the site

DocumentHow to produce itDocumentation
System report: versions, PHP, database, extensions, health checksSetup > System information, /setup/info/report downloads it as a text file; or ./console exp:system:info --jsonSystem information
Content model: classes and their attributesSetup > Classes, each class page; or the site archive's typed manifestClass groups, Data export formats
Roles, policies and assignmentsUser accounts > roles; each role's pageRoles and policies
Sections and object statesSetup > Sections, Setup > StatesSections, Object states
Workflows and triggersSetup > Workflows, Setup > TriggersWorkflows
Settings and where each value comes fromthe settings page; or exp:iniThe settings page, exp:ini
Active extensions and their orderSetup > ExtensionsThe Extensions page
Scheduled jobsSetup > CronjobsCronjobs
URL aliases and wildcardsURL translator, URL wildcardsURLs and aliases

The system report leaves out passwords, keys and server paths, so it can be shared with a new supplier; settings files cannot (see Keys and secrets handover).

What only the supplier knows

Require written documentation, kept current during the contract, of:

  • Custom code: each custom extension and design, its purpose, its templates and overrides, how to build and deploy it, in a README in its Git repository.
  • Integrations: each connected system, direction, protocol, credentials location (not the credentials), contacts.
  • Deployment: how a change reaches production, environments, the deploy commands (Deploying).
  • Operations: backup schedule and location, monitoring, cron entries, log rotation, known recurring problems and their fixes (runbooks in the style of Hosting runbooks).
  • Decisions: why the content model is shaped as it is, accessibility choices of the design, security settings changed from the defaults.
  • Editorial guides written for your editors (Handing over to editors).

The product documentation

The product documentation does not need handing over: it ships with every installation in doc/ and is shown as help in the administration (Help system). It is free documentation under the GNU FDL 1.3 or later, so your own manuals may copy and adapt it (Free documentation). Your handover documents only need to cover what is specific to your site.

A handover checklist

[ ] System report (Setup > System information > report), dated
[ ] Content model: classes and attributes, with their purpose
[ ] Roles, policies, assignments; sections; states; workflows and triggers
[ ] Settings changed from the defaults, and why
[ ] Active extensions, versions, order; custom extensions with READMEs in Git
[ ] Integrations described; credentials locations listed
[ ] Deployment procedure and environments
[ ] Operations: backups, monitoring, cron, runbooks
[ ] Editorial guides
[ ] Open issues and known bugs
[ ] Walk-through session with the receiving party held on <date>

Pitfalls

  • Documentation written only at the end, from memory. Require it as a deliverable at each milestone.
  • Credentials pasted into documents. Document where they are, never what they are.
  • A handover with no walk-through: book a session where the receiving party asks questions.

Become an Exponential Partner

Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x