How to Write a Good Technical Specifications Document

Posted in: Blog, Methodologies, Project Delivery | Jan 10, 2013 at 1:36 PM

You’ve now learned how to write a good functional requirements document and now it’s time to write a technical specifications document. Is it actually needed? Well, it depends.

What is technical specifications document anyway?

While functional requirements document captures what client wants, technical specifications document layout HOW you will approach the functional requirements technically. It will be fully technical (eg. what technology you use, the database structure, etc).

For example, client needs a website that allows visitors to register. The technical specifications document will mention something like, “A ASP.NET session will be used to store visitor ID then a temporary session record will also be added to the database, etc”. Another example will be client needs to have a drop-down-menu then in the document you’ll mention, “ABC Drop-Down-Menu will be used with custom javascript”, etc.

What is the purpose of technical specifications document?

The purpose of having this document is obviously to record the “magic” behind the website you create. Therefore, if you need to re-visit the project 1-2 years later, you know what it has.

Is it compulsory?

It normally is. Writing technical doco however consumes time but trust me, it’s worth the time.

What’s in there?

So, what does this document contain?

– Technology used

– Database schema

– Any custom Javascript and other scriptings

– CSS classes used

– etc (other framework used)

We have to be diligent enough to keep updating this document as soon as our approach changes. For example, instead of saving the user to database, we will save the user to an XML file. Any technical changes have to be reflected in the document. If you get lazy (like I am), keep reminding yourself what the purpose of this document is. It’s really-really for our own benefit.

Written by Tommy Segoro

A web solution expert who has passion in website technologies. Tommy has been in the web industry for more than 10 years. He started his career as a PHP developer and has now specialized in ASP.NET, SharePoint and MS CRM. During his career he has also been in many roles: system tester, business analyst, deployment and QA manager, team and practice leader and IT manager.

View all posts by: Tommy Segoro

No Comments Yet.

You must be logged in to post a comment.

Our Services

We provides you the best Services in our themes.

Portfolio

Click on the link below to see a full list of clients which we have developed solutions and provided consultancy for.

READ MORE
[S]olution Driven and [S]imple

We are solution-centered and not application-centered.

READ MORE
[F]untastic

Being creative and having fun and yet still delivering a fantastic service is the center of our values.

READ MORE
[T]imely

TFS Consulting Services guarantees delivery that is within budget and deadline or you engage us for free.

READ MORE

As long as you have the right methodologies

We have heard a lot of complaints from our clients that IT a lot of the times give them headache. The issues range from over-budget implementation, server is too hard to maintain, application is not user friendly, features not complete and many others. If you have ever experienced similar situations, don’t worry. This is why TFS Consulting Services is here. We exist to help clients implementing a successful IT solution. We have various methodologies which we have proven working in delivering a successful IT implementation. Below is the list of some of our key service offerings:

Planning and Methodologies

Implementing IT solution does not have to be difficult. TFS Consulting Services has a lot of resources on planning and methodologies that will ensure successful delivery of your IT solution. TFS Consulting Services has been around in the web industry for more than 10 years and has experienced all the successes and failures of various type of IT deployment.

Technical Resource

Do you need a technical resource? TFS Consulting Services can also provide you with technical resource for developing ASP.NET (C# and VB.NET), SharePoint (2003, 2007, 2010, 2013) and MS CRM applications. Our resource is an Microsoft Certified Personnel (MVP) and Microsoft Certified Technology Specialist (MCTS) in all ASP.NET, SharePoint and CRM.

IT Consulting & Advice

Make sure your IT implementation is robust and scalable. TFS Consulting Services can provide consulting and advice on industry’s best practice on various web-related areas such as website security, design and usability, application-specific (such as SharePoint)’s best practice, Search Engine Optimisation (SEO), coding standards and many others.

Solution Development

Finally TFS Consulting Services provides you with solution development service. We mainly work with Microsoft technologies (ie. .NET and SQL Server), however we are also capable of developing with PHP and MySQL. If you ever need any business process automation, integration and solution development work, we are the trusted expert you should go to.

For more detailed service offerings please visit our Solutions page.

Testimonials

I’m happy to recommend Tommy as a knowledgeable and diligent developer.

Mike Stringfellow, Vivid Group

Tommy has a lot of great ideas that can be delivered into great products. It’s a pleasure working with him because he has a broad knowledge about available technologies out there and he knows what’s best for the client’s needs. He just knows how to work effectively and efficiently.

Teddy Segoro, Student Edge

I’ve worked with Tommy over the past 6 months and have found his approach to development (especially SharePoint) absolutely outstanding. Tommy goes beyond the boundries of typical software development with his ability understand what a client requires and then build it into fully fledged software solution. Coupled with his professional “Best Practice” approach, you get Continue Reading

Michael Bonham, DSC-IT