Chapter 011, Defining the System—Creating the Architecture and Documenting the Design

Software Documentation Types and Best Practices

If more than one team is expected to work on a single architecture, this can become problematic, as the precise responsibilities of each team are difficult to establish. For this reason, it is preferable to apply partitioning to the architecture until each architecture has one owning team. Finally, it is worth considering the distinction between standing capabilities of the enterprise and temporary teams mobilized to support a particular change initiative.

Although the remit of standing teams within the enterprise can be precisely defined, it is more difficult to anticipate and specify the responsibilities of possibly unknown temporary architecture teams.

Requirements for building design documentation – Riigi Teataja

In the cases of these temporary teams, each team should come under the governance of a standing architecture team and there should be a process within the ADM cycle of these teams to establish appropriate architecture partitioning. Steps within the Preliminary Phase to support architecture partitioning are as follows:.

This step applies partitioning logic to the Enterprise Architecture in order to firstly identify the scope of each team and secondly to partition the architecture under the remit of a single team. Once complete, this step should have partitioned the entire scope of the enterprise and should have assigned responsibility for each partitioned architecture to a single team. Partitioning should create a definition of each architecture that includes:.

  • The TOGAF Standard, Version - Architecture Partitioning;
  • The Chihuahua: A New or Potential Owners General Care and Information Guide.
  • Software Documentation Types and Best Practices.

This step allows governance relationships to be formalized and also shows where artifacts from one architecture are expected to be re-used within other architectures. Areas of consideration include:.

Types of documentation

Once the Preliminary Phase is complete, the teams conducting the architecture should be understood. Each team should have a defined scope and the relationships between teams and architecture should be understood. Allocation of teams to architecture scope is illustrated in Figure Creation of partitioned architectures runs the risk of producing a fragmented and disjointed collection of architectures that cannot be integrated to form an overall big picture see Part II , 4. For large complex enterprises, federated architectures - independently developed, maintained, and managed architectures that are subsequently integrated within an integration framework - are typical.

Federated architectures typically are used in governments and conglomerates, where the separate organizational units need separate architectures. Such a framework specifies the principles for interoperability, migration, and conformance. This allows specific business units to have architectures developed and governed as stand-alone architecture projects.

More details and guidance on specifying the interoperability requirements for different solutions can be found in Part III , In order to mitigate against this risk, standards for content integration should be defined and Architecture Governance should address content integration as a condition of architectural compliance. Architecture Content Framework can be used to specify standard building blocks and artifacts that are the subject of content integration standards.

For example, a standard catalog of business processes can be agreed for an enterprise. Subsequent architectures can then ease integration by using the same process list and cross-referencing other aspects of the architecture to those standard processes.

Requirements for building design documentation

If appropriate, instructions on maintenance shall be presented in the case and according to the procedure mentioned in subsection 12 3. Documents of the building design documentation are mutually complementary.

If no specifications are presented, in case of contradictions the drawings shall prevail, followed by other documents within the building design documentation. Page numbers shall include the page order number followed by the total number of pages in the document specifications, table, chart.

Also virtual models or 3D models can be added to building design documentation for informational purposes. A draft plan of construction work shall express and make it possible to evaluate the visual suitability of the construction work, interrelations of the internal and external space and the planned use of the area designed and to compare and analyse the alternatives offered.

Agile and waterfall approaches

Drawings are presented in the most common scales. A drawing presented has to be legible and understandable and unambiguous. Also virtual models or 3D models can be added to a draft plan of construction work for informational purposes. A draft plan of construction work can serve as a source document in the preparation of building design documentation. A technological design is not building design documentation as defined in section 18 of the Building Act and does not have to conform to the formalisation requirements provided in section 7 of this Regulation.

A drawing presented has to be legible and understandable and unambiguous to a specialist of the field. Also virtual models or 3D models can be added to a technological design for informational purposes. A technological design can be one of the source documents for the preparation of the building design documentation. Architectural and technical solutions of building design documentation prepared on the basis of a technological design shall be approved by the undertaking preparing the technological design and by the customer.

It has to be possible to determine the approximate cost of construction on the basis of preliminary building design documentation. Preliminary building design documentation contains as an output the justification of the solution selected and, if the construction work includes utility systems and utility work, the alternative solution selected for building them. Preliminary building design documentation shall also include a description of the size and location of technology and equipment, restrictions arising from their use, principles of placement and dimensions of service lanes and transport corridors and other specific requirements.

Requirements for the construction work quality are set and the issues of the safe use of construction work are solved at the preliminary building design documentation stage. The specifications contain a separate chapter based on subsection 3 9 of the Building Act on solutions which ensure the accessibility to and usability of public building and construction works by persons with reduced mobility and by visually impaired and hearing impaired persons.

System Design Interview Question: DESIGN A PARKING LOT - asked at Google, Facebook

The principal building design documentation presents architectural and technical solutions and all important technical requirements for building products, the construction work and parts thereof. The solutions presented have to be verified and mutually compatible. Principal building design documentation contains the technical parameters of the building products used and equipment selected and the requirements set therefor.

Principal building design documentation does not specify techniques of construction technology and key solutions of construction, architecture and construction technology. Principal building design documentation presents the principles of standard solutions of important components socle, eave, corners, jambs, etc.

Manufacturers and the names of their equipment and building products are not mentioned, as a rule. The architectural and technical solutions presented in operational building design documentation and all important technical requirements for building products, the construction work and parts thereof have to be verified and brought into mutual conformity. Operational building design documentation shall contain technical information and a description of the quality of construction work in the volume which makes it possible to specify the construction cost, perform building work and assemble and set up the equipment.

The drawings for operational building design documentation, their scales and format shall be as convenient as possible for use at construction sites as basic material for the performance of building work. If possible, any notes and additional requirements shall be presented in the drawings in such a manner that it would not be necessary to follow several drawings and the specifications at the same time.

My RT allows for:

The building products and equipment selected and their installation and setup shall be described in the drawings, tables or lists of products. Standard solutions which are adjusted to the specific situation shall be presented in operational building design documentation. The solutions of the systems and civil engineering works presented and their locations have to match and be mutually compatible to prevent interfering in their building and functioning and to make it possible to maintain and repair them.

Product drawings do not constitute building design documentation as defined in section 18 of the Building Act. If necessary, the customer may request preparation of a plan for organisation of building work from the contractor. A plan for organisation of building work does not constitute building design documentation as defined in section 18 of the Building Act.

If building work is expected to affect traffic on public roads, the traffic management during building work shall have to be described.