Wireframes
Wireframes are a basic visual guide used in web design to suggest the layout of fundamental elements in the interface. Because of this they are often completed before any artwork is developed. When completed correctly they will provide a visual reference upon which to structure each page. Wireframes also allow for the development of variations of a layout to maintain design consistency throughout the site. This is an important part of the initial development stage because it creates user expectations and helps to develop an awareness of and familiarity with the site.
Each wireframes must be identifiable with an UID or a dedicated name, these UIDs or names must be used in the site-flow, and in the macro and micro design documents. This allows maintaining consistency between the wireframes and the other documents.
At each step of the project and in case of changes in the requirements and/or in the macro/micro design phases the wireframes may be reviewed and updated (if required).
Solution Outline
The SOL has been published as a separate document, which will not be reiterated in the present document. It describes how the solution will be used to delivery the Perseide solution. The draft of the SOL published to initiate development of Release 1 of the platform has been scoped to cover the most important technical subjects including high level architecture and a detailed fit / gap analysis.
Macro Desing
The Macro design is the high-level design; it is an overview of the major system components identified in the architecture. It contains the database design for the sub-system for which the Macro Design document is being prepared for, which in case of the projects, is not something to be built from scratch, since the system already has a database design. The output from the macro design also affects the project plan, because every time you go deeper into the system details, tasks become more apparent along with the number of resources needed and the level of skills each should have. The macro design could have impact on the wireframes, thus it is necessary to review the wireframes in the macro design phase in order to insure consistency between documents. In the macro design documents we must retrieve the mapping between: the requirements, the graphical design (wireframes) and the components that are going to be used for the Tango project.
Micro Design
The Micro design is the detailed design. The micro design focuses on laying out a coding framework including the classes that need to be developed, the key methods they contain, and the key parameters to be used in communication between classes. The inputs to the micro design are the component interfaces and database design, and the requirements and use cases. As parts of the micro design are completed, work can begin on coding, writing test cases, and unit testing. Micro design, coding, and unit testing are most likely all performed by the same people. The micro design should be mentored by development leads. In the micro design documents we must retrieve the mapping between: the pages, the class and the tables that are going to be used in each iteration.
At the micro design step the interface specifications (IS integration) and the data migration specifications must be designed. The micro design documents are intended to help developers think through detailed technology design decisions. They are of greatest value to the members of the team directly involved in developing the software.
Installation guide
The installation guide must provide guidelines required to install the application on all the platforms supported. The document should describe all the prerequisite, processes, procedures, interfaces, scripts, software, parameters, patches, etc. required to install the application.
Administration guide
The administration guide must provide all additional information required to run the application on all the platforms (Development, Integration, Qualification and Production). This document should describe all the processes, procedures, interfaces, schedules, logs, parameters, scripts, etc. required to run the application e.g. starting and stopping procedure, import/export procedure, job scheduling, GUI for modifying parameters, etc., assuming that user of this documentation is trained in how to administer the applications and has a senior level of system administration experience on the platforms.
Development guide
The software development guide will be kept on this website and will reference:
The relevant level of quality for the software development as maintained in checkstyle, PMD and other templates used for automatic code quality inspection, and as subject to change and improvement.
Any useful guidance, best practices and standards used
Tools used to control the implementation of the guidance, best practices and standards.
Performance guide
Wireframes are a basic visual guide used in web design to suggest the layout of fundamental elements in the interface. Because of this they are often completed before any artwork is developed. When completed correctly they will provide a visual reference upon which to structure each page. Wireframes also allow for the development of variations of a layout to maintain design consistency throughout the site. This is an important part of the initial development stage because it creates user expectations and helps to develop an awareness of and familiarity with the site.
Each wireframes must be identifiable with an UID or a dedicated name, these UIDs or names must be used in the site-flow, and in the macro and micro design documents. This allows maintaining consistency between the wireframes and the other documents.
At each step of the project and in case of changes in the requirements and/or in the macro/micro design phases the wireframes may be reviewed and updated (if required).
Solution Outline
The SOL has been published as a separate document, which will not be reiterated in the present document. It describes how the solution will be used to delivery the Perseide solution. The draft of the SOL published to initiate development of Release 1 of the platform has been scoped to cover the most important technical subjects including high level architecture and a detailed fit / gap analysis.
Macro Desing
The Macro design is the high-level design; it is an overview of the major system components identified in the architecture. It contains the database design for the sub-system for which the Macro Design document is being prepared for, which in case of the projects, is not something to be built from scratch, since the system already has a database design. The output from the macro design also affects the project plan, because every time you go deeper into the system details, tasks become more apparent along with the number of resources needed and the level of skills each should have. The macro design could have impact on the wireframes, thus it is necessary to review the wireframes in the macro design phase in order to insure consistency between documents. In the macro design documents we must retrieve the mapping between: the requirements, the graphical design (wireframes) and the components that are going to be used for the Tango project.
Micro Design
The Micro design is the detailed design. The micro design focuses on laying out a coding framework including the classes that need to be developed, the key methods they contain, and the key parameters to be used in communication between classes. The inputs to the micro design are the component interfaces and database design, and the requirements and use cases. As parts of the micro design are completed, work can begin on coding, writing test cases, and unit testing. Micro design, coding, and unit testing are most likely all performed by the same people. The micro design should be mentored by development leads. In the micro design documents we must retrieve the mapping between: the pages, the class and the tables that are going to be used in each iteration.
At the micro design step the interface specifications (IS integration) and the data migration specifications must be designed. The micro design documents are intended to help developers think through detailed technology design decisions. They are of greatest value to the members of the team directly involved in developing the software.
Installation guide
The installation guide must provide guidelines required to install the application on all the platforms supported. The document should describe all the prerequisite, processes, procedures, interfaces, scripts, software, parameters, patches, etc. required to install the application.
Administration guide
The administration guide must provide all additional information required to run the application on all the platforms (Development, Integration, Qualification and Production). This document should describe all the processes, procedures, interfaces, schedules, logs, parameters, scripts, etc. required to run the application e.g. starting and stopping procedure, import/export procedure, job scheduling, GUI for modifying parameters, etc., assuming that user of this documentation is trained in how to administer the applications and has a senior level of system administration experience on the platforms.
Development guide
The software development guide will be kept on this website and will reference:
The relevant level of quality for the software development as maintained in checkstyle, PMD and other templates used for automatic code quality inspection, and as subject to change and improvement.
Any useful guidance, best practices and standards used
Tools used to control the implementation of the guidance, best practices and standards.
Performance guide
