A technical specification is a document that explains what a product or project will do and how you will achieve these goals.In a tech spec, show your client and team members what problem you are solving, the goals or requirements for your project or product, and how you plan to achieve this.As your project progresses, you will typically rewrite the tech spec as you see fit.
Step 1: The name of the project should be put at the top.
This is the working title of the project or the name of your product.It's easy to read in a sans serif style.Depending on your preferences, left or center justify it.A template that shows you how to write your title can be provided by your workplace.If one is available, follow the template.
Step 2: The name of the project should be written below the date.
Go to the next line and reduce your size.You used to write your project name in sans-serif.To type in the date, use the month, day and year.Your date should be formatted according to the template.Dates are important to know which tech spec is the most recent.
Step 3: Under the date, type the author's name.
Go to the next line and write the author.Since you are the one writing the tech spec, put your name on it.If you discuss the contents of your tech spec with a team, put just your name.Even if you are working with a team, a tech spec needs to have one author.The person who types up the spec is the author.
Step 4: The names of the team members should be placed last.
On the next line, type Team followed by a colon.Write out the names of the team members who are working on the project.This helps people understand who they can go to if they have a question about the tech spec.skip this step if you worked alone on this project
Step 5: Provide a synopsis of the project or product.
A summary of what you are doing is needed to start your tech spec.The first thing you should do is type "Overview" or "Brief Summary" as your headline.Explain what the project is and what it will do.If it's equipment, explain what your approach will be and include product specifications.Marketing and engineering documents are important to the project.Give a rough time estimate for how long it will take to complete the project.The current system for planning transit trips across the county leaves riders stranded and lowers ridership on certain routes.Two of the bus systems allow riders to plan their trip online, while the third uses paper maps and phone contact.The solution is causing under funding.Users can access online the 1 planning system that we want to move the transit lines onto.They will be able to plan their trips more easily if they know when the buses are at each stop.Riders can use a 'contact us' function to report issues.
Step 6: If they aren't in the overview or brief summary, include a goals section.
If you want to outline what you plan to accomplish with your project or product, type "Goals" in the title.List your goals in a numbered or bulleted list after you write a lead-in statement.The overview section is usually not needed if you outline your goals in the section.If your workplace requires it, you may be required to include this section.The new system will include a route planning tool, a bus locator function, and a way for riders to report problems.
Step 7: The requirements should be written in a separate section.
The things your product needs to do to solve your problem should be followed by the product requirements.Don't worry about a lead-in sentence, use a bullet list.The contact box allows transit planners to respond directly to rider issues.
Step 8: There are things that are not part of the project.
Don't write a lead-in or paragraphs in the title of this section.A bullet list of the things you aren't going to do will solve your problem.This also includes work that you won't do, solutions that are not going to work, and attributes that will not work.The client and your team will not have any misunderstandings if you are thorough.You might write, "This system won't add new bus routes, we will not install computers at bus stops or on buses, so riders will need to use their own devices, and the transit planners wont guarantee immediate solutions to rider problems."
Step 9: If you have unresolved issues, include an "open questions" section.
Your tech spec is a quick outline of the product or project so your client understands what they are getting and your team is working on the same goals.Don't worry about answering your "to be determined" questions.If you want to present a bullet list of the things you will decide later, type the heading "Open Questions"Write, "How will we manage system updates?"Will the route maps be changed if there is a problem?Can there be no translation errors with the system?How will we best serve riders who are not tech savvy?
Step 10: The "Approach" section is where you should present your plan.
If a final decision hasn't been made, describe how you will solve the problem or different approaches you are considering.Explain how you will use the technology.It is easier for your readers to understand your plan if you include illustrations, charts, and diagrams.Discuss what you will do if there is an issue with your plan.If you want your plan to be easy to follow, you should create a subsection for each approach.We will work with the transit planning team to design software that allows riders to input their destinations into an app that will generate a route for them.Riders can change the route if they want.Text updates will be sent to riders to help find their routes.The software will be tested by the riders on the stakeholder committee before it is released to the public.We will make site updates if the plan has errors.An extra shuttle bus will be available to pick up stranded passengers.
Step 11: The other options were ruled out.
This section can be placed at the end of your spec or as a substep in your plan.The alternatives you considered before you decided on your current plan can be found in the "Other Options Considered" section.Tell me why you ruled out each option.You might say, "We considered color-coded maps because it's a cheaper option, but riders didn't respond well to the existing maps and the test group got confused."
Step 12: Discuss your methods and metrics for evaluating a project.
This information can be included in one section or multiple sections.In one or more paragraphs, explain how you will make sure your product or project is working correctly and accomplish your goals.Explain how you will check for problems.Specific analytical processes or technologies should be included.We will compare projected route times to actual routes to make sure buses are on schedule.We will conduct a rider survey to evaluate their satisfaction and find problems with the system.
Step 13: How will you give security and privacy?
If you want to explain how you will protect users from cyber attacks, you need to type the phrase Security and Privacy.Give a brief description of the risks and how you will protect the privacy of your system.If you want to explain your methods, write a couple of paragraphs.Don't put "there are no risks" in this section because there are always risks and concerns.Users will enter their location and home addresses.They can create a profile and save trips.We will include a firewall to protect this data.
Step 14: Finish with a list of things to do.
A timeline helps keep your project on track and tells both your client and your team what needs to be done.The tasks should be broken down according to who is doing them.Depending on your preferences, include a bullet list for each team member.The bullet list for the engineering team might include tasks such as: 1) Write website upgrade; 2) Write trip planning app; and 3) Write contact system.
Step 15: If you want to skip a line between sections, single-space your document.
If you want your tech spec to be shorter, use single spacing.If you want to change paragraphs or sections, just skip one line.This helps the reader keep up.You may get different instructions from your workplace or instructor.Follow these instructions if it's true.
Step 16: You can use a first-person point-of-view.
When discussing work that you and your team will accomplish, always use the first-person pronouns "I," "me," and "us."It's clear who you're talking about if you use their name.The reader knows how to complete each action because the tech spec is direct."We will update the specifications as needed" rather than "The specifications will be updated as necessary.""Amy will draft a marketing plan" or "The engineering team will write a website" are examples.
Step 17: It's easy to follow clear and concise text.
It's a waste of time to elaborate on your ideas in a tech spec.To make it easy to follow, use as few words as possible and organize your thoughts.If you want your report to be more direct, eliminate unnecessary wording and repetitive sentences.You can change "We will write a website that allows riders to plan their desired trip and keep track of the bus" to "This website allows trip planning and bus tracking."
Step 18: Provide feedback and review your tech spec with a partner.
If you want someone to understand your tech spec, share it with them.Ask them to mark errors and give you feedback on where you can improve.Someone who doesn't understand your field should not see your tech spec.They might recommend changes that aren't necessary.
Step 19: If there are changes that need to be made, revise your tech spec.
Go back through your tech spec and make any necessary revisions based on the feedback you received.Make the tech spec understandable to your team and clients.Don't worry, it's not perfect.As your project progresses, you will likely need to update your tech spec.Don't let the temporary document stop you from doing your actual work.
Step 20: Before you distribute your tech spec, proofread it.
Make sure to read through your tech spec at least twice.To help you catch your mistakes, read it aloud.There are things that can change the meaning of a document.Errors like "the current system is efficient" should be looked for.