Design Documentation Flashcards
What is Design Documentation?
Design documentation is a collection of documents and resources that covers all aspects of your product design. Documentation should include information about users, product features, and project deadlines; all essential implementation details; and design decisions that your team and stakeholders have agreed on.
For example: data designs, test designs,
what are the benefits of good software designs?
Better designed software is more Flexible. So, you can add a new component to the existing software without affecting the existing software.
Well-designed software increases Reusability. Because if you follow design patterns diligently, your software would be more modular.
Easy to understand. It has been always a headache to explain projects to new hires/team members. But if you have good design & documentation, you can easily communicate the idea of the software to your new team member.
Cost-efficiency is increased.
what are the two phases of software design?
Conceptual Design & Technical Design
What is Conceptual Design?
Conceptual Design - is putting software together in a non-technical manner. For example, you might want to list out all the components and their behaviours.
Examples are; Wireframes Mockups & Flow chart Component diagrams Class-Responsibility-Collaboration (CRC) cards.
what is Technical Design?
Technical Design - After completing the conceptual design, now you might think about the technical- In technical design, you basically deal with how the implementation would be done.
Examples are; Class Diagrams Activity diagram Sequence diagram ERD’s
Conceptual design
what are Wireframes used for?
A wireframe is commonly used to lay out content and functionality on a page which takes into account user needs and user journeys. Wireframes are used early in the development process to establish the basic structure of a page before visual design and content is added.
Conceptual design
what are Flowcharts used for?
A flowchart is a graphical diagram that depicts a process, system or computer algorithm.. It includes data inputs and outputs, data stores, and the various sub processes the data moves through.
Conceptual design
what is UML?
The Unified Modelling Language (UML) is a widely adopted standard for creating a variety of diagrams which can be useful in your work as a developer.
Conceptual design
what is CRC?
Class-Responsibility-Collaboration
CRC’s are a brainstorming tool used in the design of object-oriented software.
Conceptual design
what is a component diagram used for?
A component diagram allows verification that a system's required functionality is acceptable. These diagrams are also used as a communication tool between the developer and stakeholders of the system.
Technical design
what is an activity diagram?
Activity diagram is another important diagram in UML to describe the dynamic aspects of the system. Activity diagram is basically a flowchart to represent the flow from one activity to another activity. Such as business workflow, the activity can be described as an operation of the system.
Technical design
what is a use case diagram?
a use case diagram can summarise the details of your system’s users ( actors) and their interactions with the system.
what are the two types of domain modelling?
sequence diagrams represent the flow of information throughout your domain.
class diagrams represent the relationships between objects in your model.
