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
HSE simplified advice for installers of stone worktops
After company fined for repeatedly failing to protect workers.
Co-located with 10th year of UK Construction Week.
How orchards can influence planning and development.
Time for knapping, no time for napping
Decorative split stone square patterns in facades.
A practical guide to the use of flint in design and architecture.
Designing for neurodiversity: driving change for the better
Accessible inclusive design translated into reality.
RIBA detailed response to Grenfell Inquiry Phase 2 report
Briefing notes following its initial 4 September response.
Approved Document B: Fire Safety from March
Current and future changes with historical documentation.
A New Year, a new look for BSRIA
As phase 1 of the BSRIA Living Laboratory is completed.
A must-attend event for the architecture industry.
Caroline Gumble to step down as CIOB CEO in 2025
After transformative tenure take on a leadership role within the engineering sector.
RIDDOR and the provisional statistics for 2023 / 2024
Work related deaths; over 50 percent from construction 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.