PKI Feature Template

From Dogtag
Jump to: navigation, search

[Feature Name]

Overview

TBD

Short overview of the problem set and any background material or references one would need to understand the details.

Associated Bugs and Tickets

TBD

Provide URLs to all associated bugs and tickets.

Use Cases

TBD

Walk through one or more full examples of how the feature will be used. These should not all be the simplest cases.

Operating System Platforms and Architectures

TBD

Provide the initial operating systems and architectures.

Design

TBD

The proposed solution. This may include but is not limited to:

  • new schema
  • syntax of commands
  • logic flow
  • access control considerations

Implementation

TBD

Any additional requirements or changes discovered during the implementation phase.

Include any rejected design information in the History section.

Major configuration options and enablement

TBD

Any configuration options? Any commands to enable/disable the feature or turn on/off its parts?

Cloning

TBD

Any impact on cloning?

Updates and Upgrades

TBD

Any impact on updates and upgrades?

Tests

TBD

Identify any tests associated with this feature including:

  • JUnit
  • Functional
  • Build Time
  • Runtime

Dependencies

TBD

Any new package and library dependencies?

Packages

TBD

Provide the initial packages that finally included this feature (e. g. - pki-core-10.1.0-1).

External Impact

TBD

Impact on other development teams and components?

History

ORIGINAL DESIGN DATE:   [Provide the original design date in 'Month DD, YYYY' format (e. g. - September 5, 2013).]

Document any design ideas that were rejected during design and implementation of this feature with a brief explanation explaining why.

Note that this section is meant for documenting the history of this design, not the history of changes to the Wiki.