Design documentation - Revision history

Editor at 18:07, 25 October 2021

2021-10-25T18:07:41Z

← Older revision		Revision as of 18:07, 25 October 2021
Line 5:		Line 5:
	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.		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 [~~[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps~~://xd.adobe.com/ideas/principles/web-design/design-documentation/~~%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|~~Design Documentation: Why You Need It]], Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:	+	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 [https://xd.adobe.com/ideas/principles/web-design/design-documentation/ 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.		* Making documentation usable for the target audience.
Line 53:		Line 53:
	* Quality management systems (QMS) - beyond the documentation.		* Quality management systems (QMS) - beyond the documentation.
	* Record keeping.		* Record keeping.
		+	* User experience UX.

	= External resources =		= External resources =

−	* Nick Babich, [~~[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps~~://xd.adobe.com/ideas/principles/web-design/design-documentation/~~%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|~~Design Documentation: Why You Need It]].	+	* Nick Babich, [https://xd.adobe.com/ideas/principles/web-design/design-documentation/ Design Documentation: Why You Need It].

	[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]		[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]

Editor at 17:58, 25 October 2021

2021-10-25T17:58:48Z

← Older revision		Revision as of 17:58, 25 October 2021
Line 5:		Line 5:
	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.		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 [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]], Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:	+	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 [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|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.		* Making documentation usable for the target audience.
Line 56:		Line 56:
	= External resources =		= External resources =

−	* Nick Babich, [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]].	+	* Nick Babich, [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]].

	[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]		[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]

Designing Buildings at 07:27, 19 October 2021

2021-10-19T07:27:47Z

← Older revision		Revision as of 07:27, 19 October 2021
Line 5:		Line 5:
	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.		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 [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]], Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:	+	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 [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|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.		* Making documentation usable for the target audience.
Line 15:		Line 15:
	* Providing visual samples in the documentation.		* Providing visual samples in the documentation.

−	Generally, 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 ~~solidify~~ expectations and expedite the achievement of goals.	+	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.

	= Building design documentation =		= Building design documentation =
Line 21:		Line 21:
	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.		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 ~~factors in~~ a building project, including decisions that have been made in the design to satisfy ~~the~~ business ~~and~~ technical requirements and support the execution of the design.	+	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, ~~technical~~ drawings, ~~instructions on maintenance~~ and other relevant documents (explanatory diagrams, tables and charts ~~for drawings~~, ~~expert opinions~~ and ~~survey reports and other documents~~).	+	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 ~~competence~~ of the ~~persons undertaking that work~~, ~~based on education, experience, skill~~ and ~~training. In~~ other ~~words, there must be a balance between the~~ information ~~provided and the capability of the staff-member to complete the work successfully~~.	+	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:		There are a number of articles on Designing Buildings describing particular types of documentation and documents:

−	* Contractual documents.
	* Contract documents.		* Contract documents.
	* Tender documentation.		* Tender documentation.
	* Types of drawings.		* Types of drawings.
	* Briefing documents.		* Briefing documents.
		+	* Specifications.
		+	* Legislation.
		+	* Regulations.
		+	* Planning permission.
		+	* Certificates.
		+	* Permits.
		+	* Approvals.
		+	* BIM.
	* Construction contract certificates, notices and instructions.		* Construction contract certificates, notices and instructions.
		+
		+	For more information see: Design process.

	= Related articles on Designing Buildings =		= Related articles on Designing Buildings =
Line 47:		Line 56:
	= External resources =		= External resources =

−	* Nick Babich, [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]].	+	* Nick Babich, [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]].

	[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]		[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]

Editor at 15:42, 18 October 2021

2021-10-18T15:42:52Z

← Older revision		Revision as of 15:42, 18 October 2021
Line 5:		Line 5:
	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.		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 [[w/index.php?title=W/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]], Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:	+	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 [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|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.		* Making documentation usable for the target audience.
Line 39:		Line 39:

	* Commissioning documentation.		* Commissioning documentation.
−	* Contract documentation.
	* Document.		* Document.
	* Handover to client.		* Handover to client.
Line 48:		Line 47:
	= External resources =		= External resources =

−	* Nick Babich, [[w/index.php?title=W/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]].	+	* Nick Babich, [[w/index.php?title=W/index.php%3Ftitle%3DW/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]].

	[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]		[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]

Editor at 15:41, 18 October 2021

2021-10-18T15:41:49Z

← Older revision		Revision as of 15:41, 18 October 2021
Line 5:		Line 5:
	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.		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 [[w/index.php?title=~~Https~~://xd.adobe.com/ideas/principles/web-design/design-documentation/&action=edit&redlink=1\|Design Documentation: Why You Need It]], Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:	+	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 [[w/index.php?title=W/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|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.		* Making documentation usable for the target audience.
Line 41:		Line 41:
	* Contract documentation.		* Contract documentation.
	* Document.		* Document.
		+	* Handover to client.
	* Project brief for design and construction.		* Project brief for design and construction.
	* Quality management systems (QMS) - beyond the documentation.		* Quality management systems (QMS) - beyond the documentation.
Line 47:		Line 48:
	= External resources =		= External resources =

−	* Nick Babich, [[w/index.php?title=~~Https~~://xd.adobe.com/ideas/principles/web-design/design-documentation/&action=edit&redlink=1\|Design Documentation: Why You Need It]].	+	* Nick Babich, [[w/index.php?title=W/index.php%3Ftitle%3DHttps://xd.adobe.com/ideas/principles/web-design/design-documentation/%26action%3Dedit%26redlink%3D1&action=edit&redlink=1\|Design Documentation: Why You Need It]].

	[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]		[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]

Editor at 15:40, 18 October 2021

2021-10-18T15:40:12Z

← Older revision		Revision as of 15:40, 18 October 2021
Line 1:		Line 1:
−	[[File:DocumentationStacks.jpg]]	+	[[File:DocumentationStacks.jpg\|link=File:DocumentationStacks.jpg]]

	= Introduction =		= Introduction =

−	Documentation is the process, act or instance of classifying, annotating or authenticating information contained within documents for purposes of factual verification or permanent ~~recordkeeping~~. A document is a representation of information in a written, drawn or digital form.	+	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 [[~~_https~~://xd.adobe.com/ideas/principles/web-design/design-documentation/\|Design Documentation: Why You Need It]], Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:	+	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 [[w/index.php?title=Https://xd.adobe.com/ideas/principles/web-design/design-documentation/&action=edit&redlink=1\|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.		* Making documentation usable for the target audience.
Line 23:		Line 23:
	Ideally, this collection of documents and resources should cover all design factors in a building project, including decisions that have been made in the design to satisfy the business and technical requirements and support the execution of the design.		Ideally, this collection of documents and resources should cover all design factors in a building project, including decisions that have been made in the design to satisfy the business and technical requirements and support the execution of the design.

−	This can include specifications, technical drawings, instructions on maintenance and other relevant documents (explanatory ~~diagrammes~~, tables and charts for drawings, expert opinions and survey reports and other documents).	+	This can include specifications, technical drawings, instructions on maintenance and other relevant documents (explanatory diagrams, tables and charts for drawings, expert opinions and survey reports and other documents).

	The amount and depth of the documentation will depend on the competence of the persons undertaking that work, based on education, experience, skill and training. In other words, there must be a balance between the information provided and the capability of the staff-member to complete the work successfully.		The amount and depth of the documentation will depend on the competence of the persons undertaking that work, based on education, experience, skill and training. In other words, there must be a balance between the information provided and the capability of the staff-member to complete the work successfully.
Line 38:		Line 38:
	= Related articles on Designing Buildings =		= Related articles on Designing Buildings =

		+	* Commissioning documentation.
		+	* Contract documentation.
	* Document.		* Document.
−	* Quality management systems (QMS) - beyond the documentation.~~<br />~~	+	* Project brief for design and construction.
−		+	* Quality management systems (QMS) - beyond the documentation.
		+	* Record keeping.

	= External resources =		= External resources =

−	* Nick Babich, [[~~_https~~://xd.adobe.com/ideas/principles/web-design/design-documentation/\|Design Documentation: Why You Need It]].	+	* Nick Babich, [[w/index.php?title=Https://xd.adobe.com/ideas/principles/web-design/design-documentation/&action=edit&redlink=1\|Design Documentation: Why You Need It]].
		+
		+	[[Category:DCN_Definition]] [[Category:DCN_Project_Knowledge]] [[Category:DCN_Software]] [[Category:Definitions]] [[Category:Construction_management]]

Editor: Created page with "File:DocumentationStacks.jpg = Introduction = Documentation is the process, act or instance of classifying, annotating or authenticating information contained within docume..."

2021-10-18T15:33:40Z

Created page with "File:DocumentationStacks.jpg = Introduction = Documentation is the process, act or instance of classifying, annotating or authenticating information contained within docume..."

New page

[[File:DocumentationStacks.jpg]]

= Introduction =

Documentation is the process, act or instance of classifying, annotating or authenticating information contained within documents for purposes of factual verification or permanent recordkeeping. 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 [[_https://xd.adobe.com/ideas/principles/web-design/design-documentation/|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, 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 solidify expectations and expedite the achievement of goals.

= 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 factors in a building project, including decisions that have been made in the design to satisfy the business and technical requirements and support the execution of the design.

This can include specifications, technical drawings, instructions on maintenance and other relevant documents (explanatory diagrammes, tables and charts for drawings, expert opinions and survey reports and other documents).

The amount and depth of the documentation will depend on the competence of the persons undertaking that work, based on education, experience, skill and training. In other words, there must be a balance between the information provided and the capability of the staff-member to complete the work successfully.

There are a number of articles on Designing Buildings describing particular types of documentation and documents:

* Contractual documents.
* Contract documents.
* Tender documentation.
* Types of drawings.
* Briefing documents.
* Construction contract certificates, notices and instructions.

= Related articles on Designing Buildings =

* Document.
* Quality management systems (QMS) - beyond the documentation.<br />

= External resources =

* Nick Babich, [[_https://xd.adobe.com/ideas/principles/web-design/design-documentation/|Design Documentation: Why You Need It]].