Offices

From UG

Jump to: navigation, search


Contents

General Info and Scope

  • Classified As: (small) (large) component / common feature / misc
  • Parent Mantis: tbd
  • Prerequisites: any articles that must be read before to understand this?
  • Short wiki redirect Offices

Scope

  • List what it covers and what it does not

Business Requirements

  • This section is defined by Business Analyst
  • In this section this component/feature is defined from the business standpoint. All important points are listed. It could include some design details if business insists on specific design.

Notes from Systems Architect

  • This section is defined by Systems Architect. It is written after #Business Requirements are defined.
  • The purpose of this section is to give direction to System Analysts who will write detailed specification.

Rapid Design

  • In some cases (component is non standard) we need to do preliminary not so detailed design before detailed final. And maybe even code it to create Prototype
  • This section does not have to be too detailed or too formalized. We shall not spend too much time on Prototypes - they can change many times.

Fields

City

  • widget type: Textbox
  • widget specific properties:
  • adjusent label:
  • default: blank
  • type/format/link to DB : Office tbl#City

Abbreviation

Name

  • widget type: Textbox
  • widget specific properties:
    • ... :
  • adjusent label: C. Customer ref#:
  • default: blank
  • type/format/link to DB : Office tbl#Name

Phone

Fax

Email

  • widget type: Textbox
  • widget specific properties:
  • adjusent label:
  • default: blank
  • type/format/link to DB : Office tbl#Email

Address

Logo Image

  • widget type: image with "Upload" button
  • widget specific properties:
  • adjusent label:
  • default: blank
  • type/format/link to DB : Office tbl#ImageLogo

Time Zone

Default Currency

Internal Invoices Default Currency

VAT Enabled

  • widget type: Checkbox
  • widget specific properties:
  • adjusent label:
  • default: blank
  • type/format/link to DB :
VAT Amount
  • widget type: Textbox.Textbox // separately for integer and decimal parts
  • widget specific properties: become visible when #VAT Enabled is checked
  • adjusent label: "VAT Amount (%):"
  • default: 0.00
  • type/format/link to DB : Office tbl#VAT

Enable QB File Import

Daily time of creating
Start since

Detailed Design

Summary

User Interface

Functionality / Use Cases

  • This section you could spit into two. But often it is hard to do since often most of functionality is UI related

Special Cases and Misc

  • If any exist

QA

This section is to be written by QA Engineer or QA Manager or Systems Analyst.

Test Cases

  • List unusual scenarios - things that user most of the time would not do but system must handle well
  • Do not list Common Test Cases - link to them

Look and Feel

Figures

Figure 1:

Misc

Link to User Guide

Questions

Request For Comments (Suggestions and Ideas)

Known Non Critical Bugs

  • Critical bugs must be posted into Mantis

Implementation: Link To DB

Implementation: Link To Front End Code

Implementation: Link To Back End Code

History of Updates

Links to Archived / Old specs

<Update type>:<Update Summary>

Update General Info

  • mantis: <link> if applicable
  • Update types: Re-design / Tweak / Etc
  • Ideally update all sections of spec (see above) right away. If you have no time to update spec now or multiple people have to be involved then define task here and come back to update later. In this case add links from here to "TBU wiki tag articles" - see above.

Update Description

  • Briefly explain what was done and list links to updated sections.
Retrieved from "https://wiki.jaguarfreight.com/Offices"
Personal tools