tzxblog blog systems - requirements and project description

v1.0

Background of the project

This is a simulation of the blog system, using their spare time, to consolidate the various processes throughout the software development cycle to develop technology-based training, documentation, and tools, supplemented by exercises. The process has sought to important documents can be traced, the key technical points are notes recorded.
As part of the technology is not the main function of the previously selected to achieve, so this be optimized and reconstruction of the original project. Since then it did not complete the process before, so this actually also be seen as a new project.


Project Process Description

The project is expected to practice the process are:

Demand and project description

Here's demands aimed at the overall context and function of the project is described as a basic guide project development, delivery standards do not demand documents, requirements and project related content temporarily into one, simple guidance document output.

Outline design

It should outline the overall design of the front and rear ends of the technology, infrastructure, basic functions and abnormal processes have explained, the output summary of the design documentation.

Database Design

Database design should contain basic data dictionary description should also contain basic data initialization sql, the output of the corresponding documents.

Interface Design

Interface docking station designed primarily for front, need to indicate request method, URL, the parameters, the parameters, the error code and the like, an output interface API documentation

Frame structures

Framework of the project to build the front end and back-end project includes building construction, this process should be recorded on the key points and finishing as well as archiving, the points will be recalled, reusable code.

Project Development

It should be noted that the project development process and outline design consistency to release an iterative manner, taking into account the required functionality and performance and code readability, scalability, normative.

function test

Function tests should demand function control instructions output test cases and test tools and scripts for use.

Performance Testing

Performance tests should output performance test scripts and tools for use.

Deployment documentation

Project deployment requires the deployment of document output, whether for deployment automation, each middleware installation, configuration and initialization will be explained.

User's manual

User's Manual Directed to the end use of software functionality, in principle, it should be easy to understand.

Imprint

Each output documents are iterative manner, you need a clear modified version number every time changes and release notes.


Functional Requirements Description

Home

Home four-column layout, navigation is divided into head, the left side of classified information below, and below the middle of the content area right below the recommended list and other information area.
Including the head of navigation back to the home page, blog, download, login button, click to jump to specific functional pages.
Click classified information specific option, you need to show the contents of the list under specific categories, arranged in reverse chronological order.
Click on the contents list region need to jump to a specific page article.
Recommended area needs to be determined.

Personal Home

Home in the usual three-column layout, navigation head into the left below the basic information and the lower right area of the table of contents.
Including the head of navigation back to the home page, blog, download, log, write blog button click to jump to specific functional pages.
Basic information should include personal information, classified information, and archiving.
Personal blog content list display area classification, clicking on a specific list of items to jump to the article details page.

Article Details

Articles need to implement basic details page of the document and display the comments and edit, to be able to support the markdown syntax.

Download

Click to download the required navigation Jump download page, showing a list of resources available for download, and upload and download files online as well as preview.

Comments

Support article details reviews, comments implement push email, while achieving message notification after landing.


project address

Github project code and documentation are hosted at the following address:
https://github.com/tuzongxun/tzxblog

Published 272 original articles · won praise 371 · Views 1.26 million +

Guess you like

Origin blog.csdn.net/tuzongxun/article/details/104116688