Skip to content

Example: doc gen manifest

docgen-manifest.md sits at the repository root and records the most recent documentation generation run: when it ran, what it documented, what it skipped, and how the repository was classified. Doc gen writes it automatically at the end of every run, and the portal parses its documentation type to decide where the repository is filed.

What reviewers should check

  • The file is at the repository root, not under docs/, and is unedited by hand.
  • ## Documentation type carries exactly one valid value: Framework, Component, Front End, Console App, Rest API, SOAP Service, Desktop App, or Windows Service. A wrong value misfiles the repository in the portal and is worth blocking on.
  • The classification basis is a concrete sentence about this repository, naming the entry point or project characteristic that produced the type.
  • Every excluded library appears under ## Libraries not documented with a real path and a reason that identifies the exclusion cause, such as a matched pattern or an orphaned project.
  • The counts reconcile: the per-library Documents generated column, the ## Document counts by type total, and the run summary total all agree.
  • Headings, table column names, and frontmatter keys match the template verbatim. This template is strict, so a renamed column is a defect even when the content is right.

Example

The document below is a complete, correct docgen-manifest.md.

View rendered example — the same document as a real page, so you can compare rendering as well as source.

---
title: Documentation generation manifest
summary: Record of the most recent documentation generation run for this repository.
status: generated
last_updated: 2026-08-14
---

# Documentation generation manifest

This file is generated and updated automatically by the SAIF Doc Gen agent at the end of every run.
Do not edit manually.

## Run summary

| Field | Value |
| --- | --- |
| Last doc gen date | 2026-08-14 |
| Run started | 2026-08-14T02:15:07Z |
| Run completed | 2026-08-14T03:41:52Z |
| Total runtime | 1h 26m 45s |
| Documentation type | Console App |
| Libraries documented | 3 |
| Total documents generated | 60 |

## Documentation type

**Type:** Console App

**Classification basis:** The top-level project `SAIF.PremiumAudit.Batch` is an
`Exe` targeting the console output type with a `Sub Main` entry point in
`Program.vb`, and the two remaining projects are class libraries referenced by
it.

## Libraries documented

| Library | Namespace | Documents generated | Notes |
| --- | --- | --- | --- |
| `SAIF.PremiumAudit.Batch` | `SAIF.PremiumAudit.Batch` | 24 | Console entry point; also owns the application-level batch lifecycle and runbook pages. |
| `SAIF.PremiumAudit.Rules` | `SAIF.PremiumAudit.Rules` | 17 | Audit rule set built on `SAIF.Framework.Validation`. |
| `SAIF.PremiumAudit.Data` | `SAIF.PremiumAudit.Data` | 19 | Data access layer; source of the `sql/` catalog including SQL-007. |

## Libraries not documented

| Library | Path | Reason |
| --- | --- | --- |
| `SAIF.PremiumAudit.Batch.Tests` | test/SAIF.PremiumAudit.Batch.Tests | Matched exclusion pattern '*.Tests' |
| `SAIF.PremiumAudit.Rules.Tests` | test/SAIF.PremiumAudit.Rules.Tests | Matched exclusion pattern '*.Tests' |
| `SAIF.PremiumAudit.TestSupport` | test/SAIF.PremiumAudit.TestSupport | Test helper: path contains 'test' segment |
| `SAIF.PremiumAudit.Prototype` | sandbox/SAIF.PremiumAudit.Prototype | Orphaned: not referenced by any .nuspec or front-end project |

## Document counts by type

| Document type | Count |
| --- | --- |
| Library index pages | 3 |
| Overview pages | 3 |
| Architecture pages | 3 |
| Dependency pages | 3 |
| Operations and process pages | 3 |
| Business rule pages | 3 |
| API index pages | 3 |
| API type pages | 39 |
| **Total** | **60** |

## Sources
- src/