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
ECA Industry Awards 2024 shortlist revealed
22 leading businesses from across the electrotechnical and engineering services sector.
Government unveils Skills England strategy
Skills England to transform opportunities and drive growth.
New Government Hub for York Given Planning Green Light
For up to 2,600 civil servants, due for completion by 2028.
Construction Skills Certification Scheme cards
July update on Professionally Qualified and Academically Qualified Person Cards.
BSRIA Briefing 2024, November 22
Sustainable Futures: Redefining Retrofit for Net Zero Living.
The CLC on driving competency in the retrofit sector
Previously published roadmap on skills for net zero.
The first labour government King's speech in fifteen years
Construction industry reactions, support and some concern.
CIOB Retrofit of Buildings Technical Information Sheet
What retrofit is, the approach to be taken and processes to be followed.
Adapting Historic Buildings for Energy and Carbon Efficiency
Historic England advice note 18, free download published.
10 retrofit projects revisited 10 years after completion.
Information orders, building liability orders and SPVs
Key BSA terms and how they impact special purpose vehicles.
Listed despite problems with its design.
Zen and the art of cycling exploration.
Design Council Homes Taskforce launched
To support government 1.5 million homes target within UK climate commitments.