Skip to main content
Version: 0.1.138 – latest

Documents

Repave writes the documents your delivery process asks for — a solution architecture document, a data dictionary, a runbook — from what it knows about each project: its architecture, catalogs, database tables, decisions and features. Each document is laid out in your organization's own template: its cover page, header, footer and closing page.

Document types​

A document type says what a document is: a name, a description of what it must cover, and, optionally, a template.

  • Your organization's types are defined by an administrator in the Admin portal and apply to every project. An administrator can mark a type Must have: every project then gets that document and cannot switch it off. Must have never blocks anything else in a project.
  • A project's own types are added from the project's Documents page with Add document type, by anyone who can edit the project. They apply to that project only.

Write the description as the document's outline: list the sections you expect. The documentation agent gives each one its own section, in that order, and writes "Not yet available in this project." for a section the project has no information on yet, rather than inventing it.

Templates​

Drop a .docx or .pdf into Template or example in the dialog: a blank template, or a past document of the same kind. Repave finds its cover page, table of contents, closing page, header and footer, and shows what it found; choose Change if it guessed a page wrong.

  • A PDF template is shown exactly: its cover and closing pages appear as they are in the PDF. The header and footer are recreated as text.
  • A Word template carries its cover and closing page's text, tables and logos, and its heading and body styles; exact positioning may differ. Upload the PDF of your template for an exact cover.
  • With no template, Repave uses a plain layout: a title page with the document's name, the project, its version and date.

To have the project name, document name, version or date filled in on the cover, type {{project}}, {{document}}, {{version}} or {{date}} where they belong in your Word template.

Sections from your template​

The same upload also tells Repave what the document should contain. The headings in the template's body become the sections under What should it cover?, one line each, numbered as in your template:

1. Purpose and scope — about 1 page.
2. Target architecture — about 3 pages, with a picture.
2.1 Containers — a table.
3. Integrations. "List every external system and how it is called."
  • A blank template gives each heading and the line of guidance under it.
  • A previous real document gives each section's length, tables and pictures, never its text: that text describes another project. The agent writes every fact from this project.
  • A PDF gives headings and guidance only; it does not say where its tables and pictures are.
  • If you already typed what the document should cover, your text is kept, and Use the N sections from … under it swaps in the template's sections.

Edit the sections like any text before you save.

Generating a document​

Open the project's Documents page from the side menu (under Design & Architecture). Required documents are listed first.

  • Generate writes the first version; Regenerate writes a new one. The agent revises the current version rather than starting again, so sections whose facts have not changed stay as they were.
  • A document type can also regenerate automatically when a feature is merged. Several merges close together cost at most one extra run.
  • If a run fails, the row says why and the previous version stays readable. View run opens the run; Try again starts another.
  • An optional organization type can be switched off for one project with its switch. Switched-off types are listed under Switched off.

Reading and downloading​

Click a document's name to read it in Repave, inside its template: the cover, a contents list linked to each section, the document, the closing page, and the header and footer.

Download saves it as a single .html file that opens in any browser, with no network and no Repave. To make a PDF, open the file and choose Print → Save as PDF: the cover and closing page print on pages of their own, and the header and footer repeat on every page.

A document whose type has been deleted stays readable and downloadable, marked Retired; it is no longer regenerated.