Design document template

From VyOS Wiki
Jump to: navigation, search

This is the high-level feature design document template. Copy and fill.

Goals and Objectices

What your feature is for, what problem it's supposed to solve etc.

Functional specification

How the feature will work, in general.

CLI syntax

Configuration Commands

Configuration mode commands, if any.

Operational example

An example of a functional setup.

Operational Commands

Operational mode commands, if any.

Testing requirements

Typical test scenarios.