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

Tender template: documentation clause

Clause text for the documentation a supplier delivers with an Exponential site - system description, content model, roles, configuration differences, operations runbooks, editor guides - in editable form under an open…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/government/procurement/tender-templates/documentation-clause.md

On this page

Tender template: documentation clause

This page is for procurement officers and IT managers who want documentation that lets another team take over. The product itself is documented in the repository, in doc/, shown in the administration's help, and is free documentation under the GNU FDL 1.3 or later (The license of this documentation). The supplier therefore does not need to re-document the product: the clause asks for what is specific to your site.

Template - adapt to your procurement rules; not legal advice

Contents

  1. The clause
  2. The documentation set
  3. Using the product documentation
  4. Notes for the evaluator

The clause

D. DOCUMENTATION

D.1 Deliverables. The Supplier delivers the documentation set in <annex> at
    acceptance and keeps it current with every release to production.

D.2 Form. Documentation is delivered in an editable, open format (for example
    Markdown in the system's repository) and is licensed to the Customer under
    <license> so that the Customer and its future suppliers may change it.

D.3 Reference, do not copy. Where the published product documentation covers a
    topic, the Supplier links the exact page and documents only what is specific
    to the Customer's system.

D.4 Language. Documentation for editors is in <languages>; technical
    documentation in <languages>.

D.5 Accessibility. Documentation meets <accessibility standard for documents>.

D.6 Verification. The Customer may ask a third party to install or restore the
    system using only the documentation; gaps found are defects.

The documentation set

DocumentContentsProduct pages to link instead of copying
System overviewsiteaccesses, designs, extensions, integrations, environmentsIntroduction, Extensions
Content modelcontent types, fields, sections, object states, workflowsContent model, Sections, Object states, Workflows
Roles and permissionseach role, its policies, who holds itRoles and policies
Configuration recordevery setting that differs from the shipped default, with the reasonThe settings page
Installation and deploymenthow to build and deploy from the repositoryDeploying, Installing Exponential: the book
Operations runbookscaches, cronjobs, backups, restore, incidentsOperating a site, Hosting runbooks
Security recordhardening done, secrets inventory (not the secrets)Security hardening for production
Editor guidesite-specific how-tos for your content typesEditing content, Publishing and versions
Accessibility statement draftper the accessibility clauseAccessibility clause

Using the product documentation

  • Editors and administrators read the help inside the administration (Help center, /exphelp/dashboard), and the "?" button opens help for the current page (Help system).
  • The help can be exported, for example as EPUB (Documentation and publishing standards).
  • Because the product documentation is under the GFDL, your own site documentation may quote and adapt it, and must keep that license for the adapted parts (Free documentation).

Notes for the evaluator

  • Ask for a sample configuration record from a past project, with customer details removed.
  • D.6 is the strongest test; schedule it before the warranty ends.

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