Report Documentation Template

Report Documentation Template

💡‎‎
[Overview of key form function

We use synced blocks to create common page errors - these can be copied and pasted into a new report to replicate content. Editing one version edits all other version

Page Overview

[What does the form do and where does it sit in the customer journey]⁠

Page Objectives

Report purpose and desired outcome

Standardised Product Features

This section documents features that are common across all customers

[Feature Name]

Expected function:

• [x]

Example:

• [Screenshot]

Variables pulled from existing reports:

• Variable name should match that used in the other report documentation

Variable Name	Source report

Variables to be input by the user:

Variable Name	Mandatory	Data Type	Validation	Error Message
	[Y/N]	[Text, integer etc]	[Validation criteria]	[Error message trigger and text]

Calculations

• [variable names and formula required]

Customised Product Features

Variations on the standard features

[Feature name used in standardised section]

Overview of the variation vs standard

• [x]

Link to a report with the customisation

• [Link]

Expected function:

• [x]

Example:

• [Screenshot]

Variables pulled from existing reports:

• Variable name should match that used in the other report documentation

Variable Name	Source report

Variables to be input by the user:

Variable Name	Mandatory	Data Type	Validation	Error Message
	[Y/N]	[Text, integer etc]	[Validation criteria]	[Error message trigger and text]

Calculations

• [variable names and formula required]

Customer specific one-off features

[Feature Name]

Relevant Jurisdiction:

Expected function:

• [x]

Example:

• [Screenshot]

Variables pulled from existing reports:

• Variable name should match that used in the other report documentation

Variable Name	Source report

Variables to be input by the user:

Variable Name	Mandatory	Data Type	Validation	Error Message
	[Y/N]	[Text, integer etc]	[Validation criteria]	[Error message trigger and text]

Calculations

• [variable names and formula required]

Known Limitations and missing functionality

User experience issues

• x

Technical Limitations

• x

Additional Resources

Jurisdiction Name	Feature Set
City of Alameda
City of Antioch
City of Berkeley
City of Burbank
City of Concord
City of Cupertino
City of Fairfield
City of Hayward
City of Madera
City of Milpitas
City of Monterey
City of Oakland
City of Petaluma
City of Pittsburg
City of Porterville
City of Rohnert Park
City of Salinas
City of San Leandro
City of San Mateo
City of Seaside
City of South San Francisco
City of Sunnyvale
City of Temecula
City of Walnut Creek
Contra Costa County
County of Monterey
Redwood City
San Mateo County
Santa Clara County
Ventura County
City of Santa Clara