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
Not buildings. Happy holiday from DB.
Future Homes Standard: Industry calls for more ambition
As the Government FHS consultation finally closes.
Improving government projects with data and AI
Enabling better outcomes, efficient modern delivery and influential leadership on government projects.
BSRIA Living Laboratory Innovation Challenge
Final days for submission, closing March 29.
Windows, their frames, forms, factors and functions.
The hidden subtleties of U-Value calculations
Different contexts and what to include as variables.
A brief run down with related articles.
Electrical sector calls for safer public EV charge points
Serious concerns about electrical safety in the public domain.
Building Blocks manifesto presented to parliament
Architects Declare call in for support of five critical policies.
The four elements of project management with APM
Analysis, expectations, collaborative communication and partnerships.
City of London launches Heritage Building Retrofit Toolkit
Empowering owners to initiate necessary adaptations.
Guidance on RAAC in listed buildings
Published by Purcell, endorsed by IHBC, SPAB and C20.
Learning from the past.
Reluctance to hire people with criminal convictions revealed
Employing People with Criminal Convictions Report.
Tackling unconscious bias; Women's History Month
Personal reflections, as the last week of March approaches.