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
Amendment to the GB Energy Bill welcomed by ECA
Move prevents nationally-owned energy company from investing in solar panels produced by modern slavery.
Gregor Harvie argues that AI is state-sanctioned theft of IP.
Heat pumps, vehicle chargers and heating appliances must be sold with smart functionality.
Experimental AI housing target help for councils
Experimental AI could help councils meet housing targets by digitising records.
New-style degrees set for reformed ARB accreditation
Following the ARB Tomorrow's Architects competency outcomes for Architects.
BSRIA Occupant Wellbeing survey BOW
Occupant satisfaction and wellbeing tool inc. physical environment, indoor facilities, functionality and accessibility.
Preserving, waterproofing and decorating buildings.
Many resources for visitors aswell as new features for members.
Using technology to empower communities
The Community data platform; capturing the DNA of a place and fostering participation, for better design.
Heat pump and wind turbine sound calculations for PDRs
MCS publish updated sound calculation standards for permitted development installations.
Homes England creates largest housing-led site in the North
Successful, 34 hectare land acquisition with the residential allocation now completed.
Scottish apprenticeship training proposals
General support although better accountability and transparency is sought.
The history of building regulations
A story of belated action in response to crisis.
Moisture, fire safety and emerging trends in living walls
How wet is your wall?
Current policy explained and newly published consultation by the UK and Welsh Governments.
British architecture 1919–39. Book review.
Conservation of listed prefabs in Moseley.
Energy industry calls for urgent reform.