Document | |
Commonly teams use digital documents that can be modified by a team. |
Why the team would use a document: | |
|
Example Best Practices | |
|
Wiki | |
Using a wiki for documentation has several advantages. |
Why the team would use a wiki: | |
|
Example Best Practices | |
|
Images | |
All projects should be fully photographed because images provide dated information of the current progress of the artifact. If the artifact has a software component then screencaptures should substitute photos. The focus of the photos should be to capture any assemblies, uses, or context that cannot be easily conferred with the internal documentation and files at a date or by reflective documentation. |
Code | |
All code should be maintained using some form of version control to maintain the dated progress in conjunction with all other advantages of using version control. In documentation the comments in the code should be augmented to add any other context that is needed for a potential uninitiated team member to understand. |
In Process Files | |
While it is getting easier to use version control for other types of files it is not as standard as it is with code. Other files (CAD designs, graphics, etc.) should have a standard naming convention with |
Communications | |
Teams should look to keep and archive all communications between members that are pertinent to the design process. |
Meetings | |
For meetings, depending on project management strategy, the important information to keep:
|
Personal Documentation | |
As a member of a design team it is important to keep your own documentation for several reasons:
|
Example best practices: | |
|