The structure of the technical specifications

The questions that I asked when writing the technical specifications for the development of the site, how to make it as simple and understandable for the customer as possible, but at the same time limit and document the capabilities of the future product (site) as much as possible. I had to look at many different examples, ways of submitting TK, looked through it - now I am sharing my ideas and conjectures.


It is no secret that TK, like any important document, should have a clear structure, and when drawing up the task it must be strictly adhered to, otherwise it will turn out to be a wild mess, in which not only the customer will not be able to understand, but also the contractor (developer) for a long time then all eyes will be puffed at it. I chose the following structure for myself:

1. Website sections. Here it is necessary to list all sections and subsections of the site that will be available on the site. it’s not necessary to describe in detail what is in each section (subsection), we will deal with this later, now we just need to list them.
2. Sample pages. Here you must list all the types of pages that you will have available on the site. For example: title page, display of search results, type of printing, etc.
3. Design layouts of sample pages. Do not be lazy and miss this item. Here, it is simply necessary to visually (or in textual form) indicate where and what elements of the site will be displayed on the page. This item can be prepared together with the designer, to solve all conceptual issues. No need to apply ready-made layouts quite schematically mark everything. This is necessary so that subsequently the customer does not have a desire to move or move one or another element.
4. The software part of the project. Do not be lazy and paint all the technologies that will be used on this site, for example, server technology - PHP or list all client technologies. This item is needed in order to protect yourself from the choice of hosting customers who do not support, for example, PHP, and so on, just in case. I think not too much ...
5. The content and functionality of the site. Here you can insert a plate with the name of the section (subsection), its description and its properties (closed section, dynamic, displayed in an additional window, item in the main menu ...).
6. Additional Information. It is necessary to indicate here those things that for one reason or another have not been settled in the previous paragraphs. There should not be many. For example: draw teasers for the following sections and a listing of these sections, develop a loan calculator (here is a description of it). Some aspects of this section can be divided into sub-sections, for example, a loan calculator: functionality, appearance, technical component, etc.

I think that this structure reflects the technological and design components of the future site in full. If there are any inaccuracies or this TK generally unsuccessfully waiting for your feedback and comments.

PS In the future I plan to write more materials on the development of TK: the method of presentation, formation and briefing with the customer.