Download as PDF, PPTX
Uploaded bySaiko Shiroto
Why inspection?
This document discusses the importance of writing documentation for enterprise IT systems. It provides three main reasons for documentation: to prevent systems from becoming "black boxes"; to enable quick fixes when problems arise; and to allow for reasonable extensions and business fit. The document also emphasizes that inspections of architecture and documentation are necessary to ensure systems are qualified for their intended purpose and to enable problem-fixing. It stresses the importance of precise architecture and high-quality documentation that clearly organizes all parts of the system to develop, extend, and quickly fix issues early.
More Related Content
Why inspection?
- 1. Inspection? About architecture ofEnterprise IT system and its documents 2nd March 2014 Saiko Shiroto
- 2. 1. Write documents? ●Documents? For What? – Prevent your system getting a black box. – For quick fix as problem happened. – Easy access to reasonable extension. – Keep it fit for your business.
- 3. 2. How doesdocuments help? You probably write・・・ 計画 Plan ドキュメント Fit for business Archi計画 ドキュメント tecture Nice and clear architecture Solve problems quickly 計画 Test ドキュメント Easy inspection
- 4. 3. Why inspectionsare necessary? ● What is caused without inspections? – Nobody could assure the product is qualified for purpose. – Nobody could even fix the problem. Not supposed to be...right? ● Make it sure what you need ● Take it easy to grow your business
- 5. 4. Architecture andDocuments ● Architecture – It is necessary for the system. – It is invisible itself. ● Documents – You can see the architecture in it. – To develop and to extend.
- 6. 4. Architecture andDocuments Architecture (invisible) Detail Design Base Design Documents (visible) Base Design Documents Detail Design Documents Detail Design Documents
- 7. 5. Quality inArchitecture ● Materialize requirements ● Everything is mentioned ● Every single part is organized Precise Imprecise
- 8. 6. Quality inDocuments ● Everything is clear ● Everything is written ● Organized, not cluttered Good Quality Bad Quality
- 9. 7. Fix problemsearly You can save time and money. Just remember those things below. ● Earlier find errors, earlier fix them ● Easily fix if it is small ● Late fix causes waste time and budget
- 10.