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
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.
The story of this knowledge quarter building.
In ecology, in hydrology, in biology and in architecture.
Creating environments that promote physical, mental, and social well-being.
UK cases of neutral current diversion
Research project looks for example contributions.
Overstocking and macro-economics cause a decline.
The 2024 update of the Common Assessment Standard
Demonstrating organisational capability’ to fulfil roles under the Building Safety Act.
56 recommendations for a better built environment
Published by the CIC ahead of the King’s Speech.
SkillELECTRIC Top 8 Competitors Named
in annual search for the UK’s best student electrician.
CIOB Diversity and Inclusion technical information sheet
Step-by-step guide on implementing D and I practices.
Conservation and the Indian City. Book review.
Reversibility in conservation ethics
Learning from painting conservation.
Where It's AT Podcast launched!
New CIAT Architectural Technology Podcast goes live.