Bài giảng Kiến trúc phần mềm: Tài liệu kiến trúc phần mềm - PGS.TS. Trần Minh Triết

Bài giảng Kiến trúc phần mềm - Tài liệu kiến trúc phần mềm cung cấp cho người học các kiến thức: Architecture documentation, documenting an architecture is good, component diagram, deployment diagram, component interfaces, component decomposition,... Mời các bạn cùng tham khảo.

Trường Đại học Khoa Học Tự Nhiên Khoa Công Nghệ Thông Tin Bộ môn Công Nghệ Phần Mềm CTT526 - Kiến trúc phần mềm Tài liệu kiến trúc phần mềm PGS.TS Trần Minh Triết tmtriet@fit.hcmus.edu.vn Version 1.0 CuuDuongThanCong.com https://fb.com/tailieudientucntt  Nội dung giảng sử dụng: Session 6: Documenting a Software Architecture slide Software Architecture Essential GS Ian Gorton Software Engineering Institute Carnegie Mellon University CuuDuongThanCong.com https://fb.com/tailieudientucntt Architecture Documentation  Architecture documentation is a thorny issue  Commonly there is no documentation covering the architecture  If it is, it’s out-of-date, inappropriate and basically not very useful  Also projects that have masses of architecture related information  Sometimes invaluable, but often it’s out-of-date, inappropriate and not very useful! CuuDuongThanCong.com https://fb.com/tailieudientucntt Documenting an Architecture is good!  Others can understand/evaluate the design  We can understand the design after a period of time  Others in the project team and development organization can learn from the architecture  We can analysis on the design, perhaps to assess its likely performance, or to generate standard metrics CuuDuongThanCong.com https://fb.com/tailieudientucntt But it’s difficult …  No universally accepted architecture documentation standard  An architecture can be complex, and documenting it in a comprehensible manner is time consuming and non-trivial  An architecture has many possible views Documenting all the potentially useful ones is time consuming and expensive  An architecture design often evolves Keeping the architecture documents current is often forgotten, especially with time and schedule pressures in a project CuuDuongThanCong.com https://fb.com/tailieudientucntt Think carefully about what to document  Project complexity  A small project may only need a ‘marketecture’  Project longevity  One-off stop gap software?  Strategic, long-term, will evolve?  Needs of stakeholders  Small team, a whiteboard might be ok  Large, dislocated team needs more  Integrators? Testers? Programmers?  Need to spend documentation dollars/euros wisely on high value products CuuDuongThanCong.com https://fb.com/tailieudientucntt UML 2.0      UML is a powerful way to document an architecture Provides a relatively formal, unambiguous description New features in UML 2.0 appropriate for architectures Good tools available, some free Can be used to depict various structural/behavioral architecture views CuuDuongThanCong.com https://fb.com/tailieudientucntt Component Diagram id Component View OrderProcessing «table» read writeQ NewOrders MailQueue 1 readQ validate CustomerSystem 1 writeQ OrderQueue readQ SendEmail send MailServer OrderSystem CuuDuongThanCong.com https://fb.com/tailieudientucntt Class Diagram cd OrderProcessing OrderReader QueueWriter 1 Validate 1 Store CuuDuongThanCong.com https://fb.com/tailieudientucntt Sequence Diagram sd Interactions OrderReader Validate Store NewOrders CustomerSystem QueueWriter OrderQueue MailQueue readOrderData success:= validateOrder success:= newOrder success:= storeOrder success:= writeQueue success:= acknowledgeOrderSuccess success:= writeQueue 10 CuuDuongThanCong.com https://fb.com/tailieudientucntt Deployment Diagram 11 CuuDuongThanCong.com https://fb.com/tailieudientucntt Component Interfaces id Component View OrderProcessing «table» QueueWrite JDBC MailQueue NewOrders QueueRead QueueWrite SendEmail CustomerServices OrderQueue QueueRead SMTP MailServer CustomerSystem OrderSystem 12 CuuDuongThanCong.com https://fb.com/tailieudientucntt Component Decomposition id Component View cd Component View OrderProcessing JDBC QueueWrite «table» MailQueue NewOrders getOrders OrderProcessing writeConfirmation «delegate» validateOrder writeOrder or: OrderReader QueueRead qw: QueueWriter «delegate» getOrders QueueWrite val: Validate OrderQueue CustomerServices QueueRead st: Store SMTP MailServer validate CustomerSystem writeConfirmation SendEmail «delegate» validateOrder «delegate» writeOrder OrderSystem ProvidedInterface1 13 CuuDuongThanCong.com https://fb.com/tailieudientucntt Document Template  Documentation is easier if there’s a template to use  Reduces start-up time for projects by providing ready-made document structures  familiarity gained with the document structure aids in the efficient capture of project design details  help with the training of new staff 14 CuuDuongThanCong.com https://fb.com/tailieudientucntt Template Headings Architecture Documentation Template Project Name: XXX Project Context Architecture Requirements 2.1 Overview of Key Objectives 2.2 Architecture Use Cases 2.3 Stakeholder Architectural Requirements 2.4 Constraints 2.5 Non-functional Requirements 2.6 Risks Solution 3.1 Relevant Architectural Patterns 3.2 Architecture Overview 3.3 Structural Views 3.4 Behavioral Views 3.5 Implementation Issues Architecture Analysis 4.1 Scenario analysis 4.2 Risks 15 CuuDuongThanCong.com https://fb.com/tailieudientucntt Summary  Some documentation is nearly always a good idea  Trick is to produce ‘just enough’ and no more  requires upfront planning and thinking  Commitment to keeps docs current  UML 2.0 makes architecture documentation easier  Some good UML 2.0 tools, try ‘em out 16 CuuDuongThanCong.com https://fb.com/tailieudientucntt ... is, it’s out-of-date, inappropriate and basically not very useful  Also projects that have masses of architecture related information  Sometimes invaluable, but often it’s out-of-date, inappropriate... complexity  A small project may only need a ‘marketecture’  Project longevity  One-off stop gap software?  Strategic, long-term, will evolve?  Needs of stakeholders  Small team, a whiteboard might... Template  Documentation is easier if there’s a template to use  Reduces start-up time for projects by providing ready-made document structures  familiarity gained with the document structure aids