Dev.Module Workflow

Module Development Workflow

Step 1: Features and Requirements

1: Feature description

• Output: text and list

2: Use cases

• Output: text and list with diagram (MS Visio)

3: Flowchart

• Business
• System
• Output: diagram (MS Visio)

Step 2: Design

1: System Architecture

• Output: diagram (MS Visio)
• Content:
  • The internal architecture of the system
  • The external architecture of the system and other related system

2: Controller && Action design

• Output

  • List

• List Template

  • IndexController
    • indexAction
      • GET: $param1, $param2, ...
      • POST: $param1, $param2, ...
      • AJAX: No
      • Template: index-index.phtml

3: Block

• Output

  • List
    • Description
    • Config list
      • Name
      • Type
      • Description
      • Default values

• List Template

  • RecentUser
    • Description: List recently log in users
    • Configs:
      • list-count
        • Description: total list count
        • Type: text
        • Default values: 40

4: Api design

• Output

  • List
    • Package
    • Method to Call
    • Description
    • Parameters
    • Return Values
    • Example

• List Template:

  • Test($name, $options = array())
    • Package: src/Api.php
    • Calling: Pi::service('api')->demo->test($name, $options);
    • Description: Test method
    • Parameters:
      • $name: name
      • $options: optional parameters
    • Return Values: boolean
    • Examples:

  $result = Pi::service('api')->demo->test('test);

5: Main Program Logical Flowchart

• Output: diagram (MS Visio)

6: Database Design

• Output

  • Table
    • Name
    • Type
    • Length
    • Default value
    • Description
  • Tables relationship
    • Tools: Workbench

• Table Template:

Name	Type	Length	Default value	Description
id	int	10	NULL	AUTO_INCREMENT PRIMARY UNIQUE

7: System Component

• Output: list
• Content: the special system resource used

8: Config design

• Output

  • List
    • Name
    • Title
    • Description
    • Category
    • Type
    • Default value

• List Template:

  • max-list-per-page
    • Title: item count
    • Description: max list count per page
    • Category: general
    • Type: text
    • Default value: 40

Step 3: Coding

1: Basic coding

2: Install

3: Complete business logic

4: Template integrated

Step 4: QA

1: Functional testing

2: Performance testing

• AB
• 并发
• 时间
• DB
• etc

3: Security testing

• SQL Injection
• Escape
• etc