First of all, hope you familiar with the term SOA and read this book, or knowledge gap will prevent you from completing this job.
Architecture Design for a web application
Objective
Architecture design will break down the app into small isolated functions that can be completed by junior developer just based on this architecture design doc alone.
Structure
Back-end only use RESTful API to send JSON data to front-end, and front-end only use RESTful API to save data to back-end. JSON data fetched is rendered through backbone.js.
Audience
Junior developers who have experience in:
-
LAMP stack
-
Yii Framework
-
Backbone.js
-
Jquery
Content
- RESTful API to Fulfill Business Requirement
DESCRIPTION, URL STRUCTURE, VERSIONS, METHOD, PARAMETERS, RETURNS
- DB Structure
-
Explanation for each segment in each table
-
How key fields work
-
Table Definition to be imported to MySQL
- Program Structure & Logic in key process, API usage, e.g.
-
Send invoice
-
Pay invoice
-
Approval
-
Payment
-
Authentication & authorization
-
3 Plans, roles, UI for different users
-
Plan Upgrades
-
Alert, message
- Example in Yii, backbone
Several examples on how back-end & front-end work together, e.g using backbone to display invoice data fetched through RESTful API in JSON format.
- Testing plan