Technical Specification Documentation (Tech Spec)
What is a technical specification & why is it important?
We have been discussing documentation for The Data Mine CRP projects off and on since the beginning of the fall semester. Why and what does it all mean? Documentation benefits more than just the project. It benefits the engineers and developers who work on the project, the teams that will utilize the work, and any project that could be developed after the project is finished. This process allows for the entire team to understand the end goal and what is involved in executing the project to its completion. Zara Cooper perfectly summarizes how this helps the development team in the “A Practical Guide to Writing Technical Specs” blog, April 6th, 2020.
A technical spec is a straightforward and efficient way to communicate project design ideas between a team and stakeholders. The whole team can collaboratively solve a problem and create a solution. As more teammates and stakeholders contribute to a spec, it makes them more invested in the project and encourages them to take ownership and responsibility. With everyone on the same page, it limits complications that may arise from overlapping work. Newer teammates unfamiliar with the project can onboard themselves and contribute to the implementation earlier.
April 6th
The sections below explain who completes the technical specification documentation and what a tech spec needs, not all sections will fit every project. However, each team should try to answer or summarize each section below. Every team is required to submit one tech spec on their project.
Who completes the technical specification?
Corporate Partner Team Documentation is a team effort.
Anyone who works on the project! Each time students or TAs work on the project they should be adding to the guide. It is much easier to add documentation as you go than to try and remember what happened in August when preparing for the May Symposium.
Because you are working as a team, make sure everyone has access to add to the Technical specification documentation Guide!
Make your own copy by navigating to the Technical Specification Guide. It is strongly recommended that this is shared with your entire team in a MS Teams Notebook or files.