Design documentation
Contents |
[edit] Introduction
Documentation is the process, act or instance of classifying, annotating or authenticating information contained within documents for purposes of factual verification or permanent record keeping. A document is a representation of information in a written, drawn or digital form.
Design documentation is a term that is sometimes associated with the development of computer software (as in architecture design documentation) and web design (as in user experience or UX). In Design Documentation: Why You Need It, Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:
- Making documentation usable for the target audience.
- Providing up-to-date documentation.
- Working on design documentation incrementally.
- Testing documentation.
- Avoiding jargon.
- Creating easy access.
- Providing visual samples in the documentation.
Generally, this sort of design documentation should include information about users, implementation details, agreed upon decisions and project deadlines. The creation of design documentation should take place during the early stages of a project in order to clarify expectations and expedite the achievement of goals.
[edit] Building design documentation
These same basic principles can apply to design documentation for building and construction. At the very least, there should be a suitable amount of documentation written to inform staff at an appropriate level of the work that they are expected to complete.
Ideally, this collection of documents and resources should cover all design aspects of a building project, including decisions that have been made during the design process to satisfy business, legal, environmental, social, technical and so on requirements and support the execution of the design.
This can include specifications, drawings, operational information, and other relevant documents (explanatory diagrams, tables and charts, standards, surveys and so on).
The amount and depth of the documentation will depend on the requirements of the design brief, and other documentation such as employers information requirements.
There are a number of articles on Designing Buildings describing particular types of documentation and documents:
- Contract documents.
- Tender documentation.
- Types of drawings.
- Briefing documents.
- Specifications.
- Legislation.
- Regulations.
- Planning permission.
- Certificates.
- Permits.
- Approvals.
- BIM.
- Construction contract certificates, notices and instructions.
For more information see: Design process.
[edit] Related articles on Designing Buildings
- Commissioning documentation.
- Document.
- Handover to client.
- Project brief for design and construction.
- Quality management systems (QMS) - beyond the documentation.
- Record keeping.
- User experience UX.
[edit] External resources
- Nick Babich, Design Documentation: Why You Need It.
Featured articles and news
Provisional RIDDOR statistics for 2023 / 2024
Work related deaths; over 50 percent from constructuon and 50 percent recorded as fall from height.
Solar PV company fined for health and safety failure
Work at height not properly planned and failure to take suitable steps to prevent a fall.
The term value when assessing the viability of developments
Consultation on the compulsory purchase process, compensation reforms and potential removal of hope value.
Trees are part of the history of how places have developed.
The increasing costs of repair and remediation
Highlighted by regulator of social housing, as acceleration plan continues.
Free topic guide on mould in buildings
The new TG 26/2024 published by BSRIA.
Greater control for LAs over private rental selective licensing
A brief explanation of changes with the NRLA response.
Practice costs for architectural technologists
Salary standards and working out what you’re worth.
The Health and Safety Executive at 50
And over 200 years of Operational Safety and Health.
Thermal imaging surveys a brief intro
Thermal Imaging of Buildings; a pocket guide BG 72/2017.
Internally insulating a historical building
An experimental DIY approach using mineral thermal lime plaster.
Tree species selection for green infrastructure: A guide for specifiers.
50 million new trees over 25 years.
Art of Building CIOB photographic competition public vote
The last week to vote for a winner until 10 January 2025.
The future of the Grenfell Tower site
Principles, promises, recommendations and a decision expected in February 2025.
20 years of the Chartered Environmentalist
If not now, when?
Journeys in Industrious England
Thomas Baskerville’s expeditions in the 1600s.
Top 25 Building Safety Wiki articles of 2024
Take a look what most people have been reading about.
Life and death at Highgate Cemetery
Balancing burials and tourism.
The 25 most read articles on DB for 2024
Design portion to procurement route and all between.