Template for development documentation (new product)

Menu Path

Where to find the feature/screen in the software

Overview

Brief description of the screen/feature. What does it do? Why would someone use it?

Prerequisites/Dependencies

What needs to be done before using this screen/feature. What does this screen/feature depend on?

User Rights/Roles

Do users need any specific rights or roles to use this feature?

Database

Where is the data for the feature stored?

Fields

Field Required Size Type Default Description
name Yes/No 1 to ? Alphanumeric|Numeric|List|Checkbox if any or None short description

Transaction Types

If this a feature/transaction screen, description of the transaction created.

Integration Points

After saving data on the screen, where else is the data used?
(Good place for a flowchart)

Troubleshooting

What can go wrong & How to correct it
(Troubleshooting chart)

Private/Confidential
The content in this document is confidential and intended for Bold Group employees internal use only.
Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted for approval.