Page History

Table of Contents

Bug Reference

The Jira issue associated with this design spec

Branch

What branch is this work being done in

Introduction

Purpose

State the purpose of the document; something like: this is functional specificationS of feature "..." which has Jira ID CS-xyzw

...

• relevant links

Document History

Glossary

Feature Specifications

...

• discussion of alternatives amongst design ideas, their resources/time tradeoffs and limitations. Explain why a certain design idea is chosen over others
• highlight architectural patterns being used (queues, async/sync, state machines, etc)
• talk about main algorithms used
• explain what components are being changed and what the dependent components are
• regarding database: talk about tables being added/modified
• performance implications: what are the improvements or risks introduced to capacity, response time, resources usage and other relevant KPIs
• preferably show class diagrams, sequence diagrams and state diagrams
• if possible, publish signatures of all methods classes and interfaces implement, and the explain the object information of different classes

...

API and Schema Changes

list changes to existing web services APIs and new APIs introduced with signatures and throughout documentation

Service Layer Changes

UI flow

Describe business/service layer changes, changes in frameworks, plugins ...

UI Changes

• One
• Two
• Three

Marvin Tests

For this feature, the following test cases or QA considerations must be made:

• CRUD tests as user or root admin for all features listed above in API section
• ...either demonstrate it visually here or link to relevant mockups

IP Clearance

• what dependencies will you be adding to the project?
• are you expecting to include any code developed outside the Apache CloudStack project?

...